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

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


如何构建PaddlePaddle的文档
==========================

H
hedaoyuan 已提交
11
PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式。构建PaddlePaddle文档需要准备的环境相对较复杂,所以我们推荐使用基于Docker来构建PaddlePaddle的文档。
Y
Yu Yang 已提交
12 13 14 15 16


使用Docker构建PaddlePaddle的文档
--------------------------------

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

..	code-block:: bash

	cd TO_YOUR_PADDLE_CLONE_PATH
Q
qijun 已提交
22
	bash paddle/scripts/tools/build_docs.sh
Y
Yu Yang 已提交
23

Q
qijun 已提交
24
编译完成后,会在当前目录生成两个子目录,build与build_doc,其中build_doc/doc目录之下包含两个子目录\:
Y
Yu Yang 已提交
25

Q
qijun 已提交
26 27
* en 英文文档目录
* cn 中文文档目录
Y
Yu Yang 已提交
28 29 30 31 32 33 34 35

打开浏览器访问对应目录下的index.html即可访问本地文档。



直接构建PaddlePaddle的文档
--------------------------

Q
qijun 已提交
36 37 38 39 40 41 42
因为PaddlePaddle的v2 api文档生成过程依赖于py_paddle Python包,用户需要首先确认py_paddle包已经安装。

..	code-block:: bash

    python -c "import py_paddle"

如果提示错误,那么用户需要在本地编译安装PaddlePaddle,请参考 `源码编译文档 <http://www.paddlepaddle.org/develop/doc/getstarted/build_and_install/build_from_source_en.html>`_ 。
Q
qijun 已提交
43
注意,用户在首次编译安装PaddlePaddle时,请将WITH_DOC选项关闭。在编译安装正确之后,请再次确认py_paddle包已经安装,即可进行下一步操作。
Q
qijun 已提交
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61

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

..	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`

编译完成之后,在build_doc/doc目录之下会生成如下两个子目录\:

* en 英文文档目录
* cn 中文文档目录

打开浏览器访问对应目录下的index.html即可访问本地文档。

Y
Yu Yang 已提交
62

H
hedaoyuan 已提交
63 64 65
如何书写PaddlePaddle的文档
==========================

Q
qijun 已提交
66
PaddlePaddle文档使用sphix自动生成,用户可以参考sphinx教程进行书写。
Y
Yu Yang 已提交
67 68 69 70

如何更新www.paddlepaddle.org文档
================================

Q
qijun 已提交
71 72
目前PaddlePaddle的develop分支的文档是自动触发更新的。用户可以在http://www.paddlepaddle.org/develop/doc_cn/与http://www.paddlepaddle.org/develop/doc/上分别查看最新的中英文文档。

Y
Yu Yang 已提交
73 74 75


..	_cmake: https://cmake.org/
L
Luo Tao 已提交
76
..	_sphinx: http://www.sphinx-doc.org/en/1.4.8/