Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
Crayon鑫
Paddle
提交
b4e459b9
P
Paddle
项目概览
Crayon鑫
/
Paddle
与 Fork 源项目一致
Fork自
PaddlePaddle / Paddle
通知
1
Star
1
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
1
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
P
Paddle
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
1
Issue
1
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
b4e459b9
编写于
4月 25, 2017
作者:
Q
qijun
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update wirte_docs_cn.rst
上级
0df032a6
变更
3
隐藏空白更改
内联
并排
Showing
3 changed file
with
21 addition
and
22 deletion
+21
-22
doc/howto/dev/write_docs_cn.rst
doc/howto/dev/write_docs_cn.rst
+13
-13
paddle/scripts/docker/build.sh
paddle/scripts/docker/build.sh
+2
-2
paddle/scripts/tools/build_docs/build_docs.sh
paddle/scripts/tools/build_docs/build_docs.sh
+6
-7
未找到文件。
doc/howto/dev/write_docs_cn.rst
浏览文件 @
b4e459b9
...
...
@@ -2,13 +2,14 @@
如何贡献/修改文档
##################
PaddlePaddle的文档包括英文文档 ``doc`` 和中文文档 ``doc_cn`` 两个部分。文档都是通过 `cmake`_ 驱动 `sphinx`_ 编译生成,生成后的文档分别存储在编译目录的 ``
en`` 和 ``
cn`` 两个子目录下。
PaddlePaddle的文档包括英文文档 ``doc`` 和中文文档 ``doc_cn`` 两个部分。文档都是通过 `cmake`_ 驱动 `sphinx`_ 编译生成,生成后的文档分别存储在编译目录的 ``
doc`` 和 ``doc_
cn`` 两个子目录下。
如何构建PaddlePaddle的文档
==========================
PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式。构建PaddlePaddle文档需要准备的环境相对较复杂,所以我们推荐使用基于Docker来构建PaddlePaddle的文档。
PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式,我们提供了一个构建脚本build_docs.sh来进行构建。
PaddlePaddle文档需要准备的环境相对较复杂,所以我们推荐使用基于Docker来构建PaddlePaddle的文档。
使用Docker构建PaddlePaddle的文档
...
...
@@ -19,12 +20,13 @@ PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式。
.. code-block:: bash
cd TO_YOUR_PADDLE_CLONE_PATH
bash paddle/scripts/tools/build_docs.sh
cd paddle/scripts/tools/build_docs
bash build_docs.sh with_docker
编译完成后,会在当前目录生成两个子目录
,build与build_doc,其中build_doc/doc目录之下包含两个子目录
\:
编译完成后,会在当前目录生成两个子目录\:
*
en
英文文档目录
* cn 中文文档目录
*
doc
英文文档目录
*
doc_
cn 中文文档目录
打开浏览器访问对应目录下的index.html即可访问本地文档。
...
...
@@ -47,15 +49,13 @@ PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式。
.. code-block:: bash
cd TO_YOUR_PADDLE_CLONE_PATH
mkdir build_doc
cd build_doc
cmake .. -DWITH_DOC=ON
make paddle_docs paddle_docs_cn -j `nproc`
cd paddle/scripts/tools/build_docs
bash build_docs.sh local
编译完成之后,
在build_doc/doc目录之下会生成如下
两个子目录\:
编译完成之后,
会在当前目录生成
两个子目录\:
*
en
英文文档目录
* cn 中文文档目录
*
doc
英文文档目录
*
doc_
cn 中文文档目录
打开浏览器访问对应目录下的index.html即可访问本地文档。
...
...
paddle/scripts/docker/build.sh
浏览文件 @
b4e459b9
...
...
@@ -57,10 +57,10 @@ 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/
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/en/html/
*
$DOC_DIR
/doc
cp
-r
/paddle/build_doc/doc/cn/html/
*
$DOC_DIR
/doc_cn
popd
rm
-rf
/paddle/build_doc
...
...
paddle/scripts/tools/build_docs/build_docs.sh
浏览文件 @
b4e459b9
...
...
@@ -9,22 +9,21 @@ function usage(){
}
MYDIR
=
"
$(
cd
"
$(
dirname
"
${
BASH_SOURCE
[0]
}
"
)
"
&&
pwd
)
"
PADDLE_SOURCE_DIR
=
$MYDIR
/../../../../
case
"
$1
"
in
"with_docker"
)
docker run
--rm
-v
$P
ADDLE_SOURCE_DIR
:/paddle
\
docker run
--rm
-v
$P
WD
/../../../../
:/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
doc
mkdir
-p
doc_cn
PADDLE_SOURCE_DIR
=
$PWD
/../../../../
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
cp
-r
$PADDLE_SOURCE_DIR
/build_doc/doc/en/html/
*
doc
cp
-r
$PADDLE_SOURCE_DIR
/build_doc/doc/cn/html/
*
doc_cn
popd
rm
-rf
$PADDLE_SOURCE_DIR
/build_doc
;;
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录