Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
TonyTonyFun
Paddle
提交
f9a5a2c0
P
Paddle
项目概览
TonyTonyFun
/
Paddle
与 Fork 源项目一致
Fork自
PaddlePaddle / Paddle
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
P
Paddle
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
f9a5a2c0
编写于
4月 25, 2017
作者:
Q
qijun
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
follow comments
上级
aa7d7e62
变更
3
隐藏空白更改
内联
并排
Showing
3 changed file
with
46 addition
and
6 deletion
+46
-6
doc/howto/dev/write_docs_cn.rst
doc/howto/dev/write_docs_cn.rst
+5
-5
paddle/scripts/docker/build.sh
paddle/scripts/docker/build.sh
+6
-0
paddle/scripts/tools/build_docs/build_docs.sh
paddle/scripts/tools/build_docs/build_docs.sh
+35
-1
未找到文件。
doc/howto/dev/write_docs_cn.rst
浏览文件 @
f9a5a2c0
...
...
@@ -16,7 +16,7 @@ PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式。
使用Docker构建PaddlePaddle的文档,需要在系统里先安装好Docker工具包。Docker安装请参考 `Docker的官网 <https://docs.docker.com/>`_ 。安装好Docker之后可以使用源码目录下的脚本构建文档,即
..
code-block:: bash
..
code-block:: bash
cd TO_YOUR_PADDLE_CLONE_PATH
bash paddle/scripts/tools/build_docs.sh
...
...
@@ -35,7 +35,7 @@ PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式。
因为PaddlePaddle的v2 api文档生成过程依赖于py_paddle Python包,用户需要首先确认py_paddle包已经安装。
..
code-block:: bash
..
code-block:: bash
python -c "import py_paddle"
...
...
@@ -44,7 +44,7 @@ PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式。
如果提示正确,可以执行以下命令编译生成文档,即
..
code-block:: bash
..
code-block:: bash
cd TO_YOUR_PADDLE_CLONE_PATH
mkdir build_doc
...
...
@@ -73,5 +73,5 @@ PaddlePaddle文档使用 `sphinx`_ 自动生成,用户可以参考sphinx教程
..
_cmake: https://cmake.org/
..
_sphinx: http://www.sphinx-doc.org/en/1.4.8/
..
_cmake: https://cmake.org/
..
_sphinx: http://www.sphinx-doc.org/en/1.4.8/
paddle/scripts/docker/build.sh
浏览文件 @
f9a5a2c0
...
...
@@ -57,7 +57,13 @@ if [ ${WITH_DOC} == "ON" ]; then
-DWITH_SWIG_PY
=
ON
\
-DWITH_STYLE_CHECK
=
OFF
make paddle_docs paddle_docs_cn
$DOC_DIR
=
/paddle/paddle/scripts/tools/build_docs/
mkdir
-p
$DOC_DIR
/doc
mkdir
-p
$DOC_DIR
/doc_cn
cp
-r
/paddle/build_doc/doc/doc/en/html/
*
$DOC_DIR
/doc
cp
-r
/paddle/build_doc/doc/cn/html/
*
$DOC_DIR
/doc_cn
popd
rm
-rf
/paddle/build_doc
fi
# generate deb package for current build
# FIXME(typhoonzero): should we remove paddle/scripts/deb ?
...
...
paddle/scripts/tools/build_docs/build_docs.sh
浏览文件 @
f9a5a2c0
#!/bin/bash
set
-e
docker run
--rm
-v
$PWD
:/paddle
-e
"WITH_GPU=OFF"
-e
"WITH_AVX=ON"
-e
"WITH_DOC=ON"
paddledev/paddle:dev
function
usage
(){
echo
"usage: build_doc [--help] [<args>]"
echo
"This script generates doc and doc_cn in the script's directory."
echo
"These are common commands used in various situations:"
echo
" with_docker build doc and doc_cn with docker"
echo
" local build doc and doc_cn locally"
}
MYDIR
=
"
$(
cd
"
$(
dirname
"
${
BASH_SOURCE
[0]
}
"
)
"
&&
pwd
)
"
PADDLE_SOURCE_DIR
=
$MYDIR
/../../../../
case
"
$1
"
in
"with_docker"
)
docker run
--rm
-v
$PADDLE_SOURCE_DIR
:/paddle
\
-e
"WITH_GPU=OFF"
-e
"WITH_AVX=ON"
-e
"WITH_DOC=ON"
paddledev/paddle:dev
;;
"local"
)
mkdir
-p
$MYDIR
/doc
mkdir
-p
$MYDIR
/doc_cn
mkdir
-p
$PADDLE_SOURCE_DIR
/build_doc
pushd
$PADDLE_SOURCE_DIR
/build_doc
cmake ..
-DWITH_DOC
=
ON
make paddle_docs paddle_docs_cn
cp
-r
$PADDLE_SOURCE_DIR
/build_doc/doc/en/html/
*
$MYDIR
/doc
cp
-r
$PADDLE_SOURCE_DIR
/build_doc/doc/cn/html/
*
$MYDIR
/doc_cn
popd
rm
-rf
$PADDLE_SOURCE_DIR
/build_doc
;;
"--help"
)
usage
;;
*
)
usage
;;
esac
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录