write_docs_cn.rst 2.3 KB
Newer Older
L
Luo Tao 已提交
1 2 3
##################
如何贡献/修改文档
##################
Y
Yu Yang 已提交
4

Q
qijun 已提交
5
PaddlePaddle的文档包括英文文档 ``doc`` 和中文文档 ``doc_cn`` 两个部分。文档都是通过 `cmake`_ 驱动 `sphinx`_ 编译生成,生成后的文档分别存储在编译目录的 ``doc`` 和 ``doc_cn`` 两个子目录下。
Y
Yu Yang 已提交
6 7


L
Luo Tao 已提交
8 9
如何构建文档
============
Y
Yu Yang 已提交
10

L
Luo Tao 已提交
11
PaddlePaddle的文档构建有两种方式。
Y
Yu Yang 已提交
12

L
Luo Tao 已提交
13 14
使用Docker构建
--------------
Y
Yu Yang 已提交
15

H
hedaoyuan 已提交
16
使用Docker构建PaddlePaddle的文档,需要在系统里先安装好Docker工具包。Docker安装请参考 `Docker的官网 <https://docs.docker.com/>`_ 。安装好Docker之后可以使用源码目录下的脚本构建文档,即
Y
Yu Yang 已提交
17

Q
qijun 已提交
18
..  code-block:: bash
Y
Yu Yang 已提交
19

Q
qijun 已提交
20
    cd TO_YOUR_PADDLE_CLONE_PATH
Q
qijun 已提交
21
    cd paddle/scripts/tools/build_docs
L
Luo Tao 已提交
22
    sh build_docs.sh
Y
Yu Yang 已提交
23

L
Luo Tao 已提交
24
编译完成之后,会在当前目录生成两个子目录\: doc(英文文档目录)和 doc_cn(中文文档目录)。
Y
Yu Yang 已提交
25 26
打开浏览器访问对应目录下的index.html即可访问本地文档。

L
Luo Tao 已提交
27 28
直接构建
--------
Q
qijun 已提交
29 30 31

如果提示正确,可以执行以下命令编译生成文档,即

Q
qijun 已提交
32
..  code-block:: bash
Q
qijun 已提交
33

Q
qijun 已提交
34
    cd TO_YOUR_PADDLE_CLONE_PATH
L
Luo Tao 已提交
35 36 37 38 39
    mkdir -p build
    cd build
    cmake .. -DCMAKE_BUILD_TYPE=Debug -DWITH_GPU=OFF -DWITH_MKLDNN=OFF -DWITH_MKLML=OFF -DWITH_DOC=ON
    make gen_proto_py
    make paddle_docs paddle_docs_cn
Q
qijun 已提交
40

L
Luo Tao 已提交
41
编译完成之后,会在当前目录生成两个子目录\: doc(英文文档目录)和 doc_cn(中文文档目录)。
Q
qijun 已提交
42 43
打开浏览器访问对应目录下的index.html即可访问本地文档。

Y
Yu Yang 已提交
44

L
Luo Tao 已提交
45 46
如何书写文档
============
H
hedaoyuan 已提交
47

Q
qijun 已提交
48
PaddlePaddle文档使用 `sphinx`_ 自动生成,用户可以参考sphinx教程进行书写。
Y
Yu Yang 已提交
49

L
Luo Tao 已提交
50 51 52 53
如何更新文档主题
================

PaddlePaddle文档主题在 `TO_YOUR_PADDLE_CLONE_PATH/doc_theme` 文件夹下,包含所有和前端网页设计相关的文件。
Y
Yu Yang 已提交
54

L
Luo Tao 已提交
55 56 57 58
如何更新doc.paddlepaddle.org
============================

更新的文档以PR的形式提交到github中,提交方式参见 `贡献文档 <http://doc.paddlepaddle.org/develop/doc_cn/howto/dev/contribute_to_paddle_cn.html>`_ 。
L
LiuYongFeng 已提交
59 60
目前PaddlePaddle的develop分支的文档是自动触发更新的,用户可以分别查看最新的 `中文文档 <http://doc.paddlepaddle.org/develop/doc_cn/>`_ 和
`英文文档 <http://doc.paddlepaddle.org/develop/doc/>`_ 。
Q
qijun 已提交
61

Y
Yu Yang 已提交
62

Q
qijun 已提交
63 64
..  _cmake: https://cmake.org/
..  _sphinx: http://www.sphinx-doc.org/en/1.4.8/