From bcdfe2cd7e827a679eab235ebe592b1c831af679 Mon Sep 17 00:00:00 2001 From: qijun Date: Mon, 24 Apr 2017 10:25:53 +0800 Subject: [PATCH 1/9] add docs --- doc/howto/dev/write_docs_cn.rst | 32 +++++++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/doc/howto/dev/write_docs_cn.rst b/doc/howto/dev/write_docs_cn.rst index 5051a89230..2420a1c959 100644 --- a/doc/howto/dev/write_docs_cn.rst +++ b/doc/howto/dev/write_docs_cn.rst @@ -37,17 +37,43 @@ PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式。 直接构建PaddlePaddle的文档 -------------------------- -TBD +因为PaddlePaddle的v2 api文档生成过程依赖于py_paddle Python包，用户需要首先确认py_paddle包已经安装。 + +.. code-block:: bash + + python -c "import py_paddle" + +如果提示错误，那么用户需要在本地编译安装PaddlePaddle，请参考 `源码编译文档 `_ 。 +注意，用户需要安装编译在首次编译安装PaddlePaddle时，请将WITH_DOC选项关闭。在编译安装正确之后，确认py_paddle包已经安装，即可进行下一步操作。 + +如果提示正确，可以执行以下命令编译生成文档，即 + +.. 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即可访问本地文档。 + 如何书写PaddlePaddle的文档 ========================== -TBD +PaddlePaddle文档使用sphix自动生成，用户可以参考sphinx教程进行书写。 如何更新www.paddlepaddle.org文档 ================================ -TBD +目前PaddlePaddle的develop分支的文档是自动触发更新的。用户可以在http://www.paddlepaddle.org/develop/doc_cn/与http://www.paddlepaddle.org/develop/doc/上分别查看最新的中英文文档。 + .. _cmake: https://cmake.org/ From f30e9f417425fdfb393092eee6dd2234d830caba Mon Sep 17 00:00:00 2001 From: qijun Date: Mon, 24 Apr 2017 15:18:04 +0800 Subject: [PATCH 2/9] polish doc --- doc/howto/dev/write_docs_cn.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/howto/dev/write_docs_cn.rst b/doc/howto/dev/write_docs_cn.rst index 2420a1c959..c8ecbc94b9 100644 --- a/doc/howto/dev/write_docs_cn.rst +++ b/doc/howto/dev/write_docs_cn.rst @@ -44,7 +44,7 @@ PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式。 python -c "import py_paddle" 如果提示错误，那么用户需要在本地编译安装PaddlePaddle，请参考 `源码编译文档 `_ 。 -注意，用户需要安装编译在首次编译安装PaddlePaddle时，请将WITH_DOC选项关闭。在编译安装正确之后，确认py_paddle包已经安装，即可进行下一步操作。 +注意，用户在首次编译安装PaddlePaddle时，请将WITH_DOC选项关闭。在编译安装正确之后，请再次确认py_paddle包已经安装，即可进行下一步操作。 如果提示正确，可以执行以下命令编译生成文档，即 From 44958781150932a27a8ff5747c8caec70113eec2 Mon Sep 17 00:00:00 2001 From: qijun Date: Mon, 24 Apr 2017 16:03:57 +0800 Subject: [PATCH 3/9] update docker build doc --- doc/howto/dev/write_docs_cn.rst | 12 ++++-------- paddle/scripts/tools/build_docs/Dockerfile | 7 ------- paddle/scripts/tools/build_docs/build.sh | 13 ------------- paddle/scripts/tools/build_docs/build_docs.sh | 3 +-- 4 files changed, 5 insertions(+), 30 deletions(-) delete mode 100644 paddle/scripts/tools/build_docs/Dockerfile delete mode 100755 paddle/scripts/tools/build_docs/build.sh diff --git a/doc/howto/dev/write_docs_cn.rst b/doc/howto/dev/write_docs_cn.rst index c8ecbc94b9..fb22b473f8 100644 --- a/doc/howto/dev/write_docs_cn.rst +++ b/doc/howto/dev/write_docs_cn.rst @@ -19,19 +19,15 @@ PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式。 .. code-block:: bash cd TO_YOUR_PADDLE_CLONE_PATH - cd paddle/scripts/tools/build_docs - bash build_docs.sh + bash paddle/scripts/tools/build_docs.sh -编译完成后，该目录下会生成如下两个子目录\: +编译完成后，会在当前目录生成两个子目录，build与build_doc，其中build_doc/doc目录之下包含两个子目录\: -* doc 英文文档目录 -* doc_cn 中文文档目录 +* en 英文文档目录 +* cn 中文文档目录 打开浏览器访问对应目录下的index.html即可访问本地文档。 -.. code-block:: bash - - open doc_cn/index.html 直接构建PaddlePaddle的文档 diff --git a/paddle/scripts/tools/build_docs/Dockerfile b/paddle/scripts/tools/build_docs/Dockerfile deleted file mode 100644 index 78dc756bd1..0000000000 --- a/paddle/scripts/tools/build_docs/Dockerfile +++ /dev/null @@ -1,7 +0,0 @@ -FROM paddledev/paddle:cpu-devel-latest -COPY build.sh / -RUN pip install sphinx &&\ - pip install sphinx_rtd_theme &&\ - apt install -y doxygen graphviz &&\ - pip install recommonmark numpy protobuf==2.6.1 -CMD /build.sh diff --git a/paddle/scripts/tools/build_docs/build.sh b/paddle/scripts/tools/build_docs/build.sh deleted file mode 100755 index a23b6e61d4..0000000000 --- a/paddle/scripts/tools/build_docs/build.sh +++ /dev/null @@ -1,13 +0,0 @@ -#!/bin/bash -set -ex - -mkdir -p /build -cd /build -cmake /paddle -DWITH_DOC=ON -make paddle_docs paddle_docs_cn -j `nproc` -mkdir -p /output/doc -mkdir -p /output/doc_cn -cp -r doc/html/* /output/doc/ -cp -r doc_cn/html/* /output/doc_cn/ -cd / -rm -rf /paddle/build diff --git a/paddle/scripts/tools/build_docs/build_docs.sh b/paddle/scripts/tools/build_docs/build_docs.sh index 9f8b80435c..fb8c26a69a 100755 --- a/paddle/scripts/tools/build_docs/build_docs.sh +++ b/paddle/scripts/tools/build_docs/build_docs.sh @@ -1,4 +1,3 @@ #!/bin/bash set -e -docker build . -t paddle_build_doc -docker run --rm -v $PWD/../../../../:/paddle -v $PWD:/output paddle_build_doc +docker run --rm -v $PWD:/paddle -e "WITH_GPU=OFF" -e "WITH_AVX=ON" -e "WITH_DOC=ON" paddledev/paddle:dev From 1397521ff2e0a96b0ccac55f99d1a1b778df7a17 Mon Sep 17 00:00:00 2001 From: qijun Date: Mon, 24 Apr 2017 16:13:17 +0800 Subject: [PATCH 4/9] format doc rst --- doc/howto/dev/write_docs_cn.rst | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/doc/howto/dev/write_docs_cn.rst b/doc/howto/dev/write_docs_cn.rst index fb22b473f8..0272fd8782 100644 --- a/doc/howto/dev/write_docs_cn.rst +++ b/doc/howto/dev/write_docs_cn.rst @@ -18,8 +18,8 @@ PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式。 .. code-block:: bash - cd TO_YOUR_PADDLE_CLONE_PATH - bash paddle/scripts/tools/build_docs.sh + cd TO_YOUR_PADDLE_CLONE_PATH + bash paddle/scripts/tools/build_docs.sh 编译完成后，会在当前目录生成两个子目录，build与build_doc，其中build_doc/doc目录之下包含两个子目录\: @@ -46,11 +46,11 @@ PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式。 .. code-block:: bash - cd TO_YOUR_PADDLE_CLONE_PATH + cd TO_YOUR_PADDLE_CLONE_PATH mkdir build_doc cd build_doc - cmake .. -DWITH_DOC=ON - make paddle_docs paddle_docs_cn -j `nproc` + cmake .. -DWITH_DOC=ON + make paddle_docs paddle_docs_cn -j `nproc` 编译完成之后，在build_doc/doc目录之下会生成如下两个子目录\: @@ -63,12 +63,13 @@ PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式。 如何书写PaddlePaddle的文档 ========================== -PaddlePaddle文档使用sphix自动生成，用户可以参考sphinx教程进行书写。 +PaddlePaddle文档使用 `sphinx`_ 自动生成，用户可以参考sphinx教程进行书写。 如何更新www.paddlepaddle.org文档 ================================ -目前PaddlePaddle的develop分支的文档是自动触发更新的。用户可以在http://www.paddlepaddle.org/develop/doc_cn/与http://www.paddlepaddle.org/develop/doc/上分别查看最新的中英文文档。 +目前PaddlePaddle的develop分支的文档是自动触发更新的，用户分别查看`中文文档 `_ 和 +`英文文档 `_ 。 From aa7d7e62b6763605ab801f8c254fef47f3fb4e3e Mon Sep 17 00:00:00 2001 From: qijun Date: Mon, 24 Apr 2017 16:22:37 +0800 Subject: [PATCH 5/9] fix typo error --- doc/howto/dev/write_docs_cn.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/howto/dev/write_docs_cn.rst b/doc/howto/dev/write_docs_cn.rst index 0272fd8782..dfe6219d8e 100644 --- a/doc/howto/dev/write_docs_cn.rst +++ b/doc/howto/dev/write_docs_cn.rst @@ -2,7 +2,7 @@ 如何贡献/修改文档 ################## -PaddlePaddle的文档包括英文文档 ``doc`` 和中文文档 ``doc_cn`` 两个部分。文档都是通过 `cmake`_ 驱动 `sphinx`_ 编译生成，生成后的文档分别存储在编译目录的 ``doc`` 和 ``doc_cn`` 两个子目录下。 +PaddlePaddle的文档包括英文文档 ``doc`` 和中文文档 ``doc_cn`` 两个部分。文档都是通过 `cmake`_ 驱动 `sphinx`_ 编译生成，生成后的文档分别存储在编译目录的 ``en`` 和 ``cn`` 两个子目录下。 如何构建PaddlePaddle的文档 @@ -68,8 +68,8 @@ PaddlePaddle文档使用 `sphinx`_ 自动生成，用户可以参考sphinx教程 如何更新www.paddlepaddle.org文档 ================================ -目前PaddlePaddle的develop分支的文档是自动触发更新的，用户分别查看`中文文档 `_ 和 -`英文文档 `_ 。 +目前PaddlePaddle的develop分支的文档是自动触发更新的，用户可以分别查看最新的 `中文文档 `_ 和 +`英文文档 `_ 。 From f9a5a2c09969e4b8a8973a9bf250090a242998dd Mon Sep 17 00:00:00 2001 From: qijun Date: Tue, 25 Apr 2017 11:21:13 +0800 Subject: [PATCH 6/9] follow comments --- doc/howto/dev/write_docs_cn.rst | 10 +++--- paddle/scripts/docker/build.sh | 6 ++++ paddle/scripts/tools/build_docs/build_docs.sh | 36 ++++++++++++++++++- 3 files changed, 46 insertions(+), 6 deletions(-) diff --git a/doc/howto/dev/write_docs_cn.rst b/doc/howto/dev/write_docs_cn.rst index dfe6219d8e..c8dd3d507f 100644 --- a/doc/howto/dev/write_docs_cn.rst +++ b/doc/howto/dev/write_docs_cn.rst @@ -16,7 +16,7 @@ PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式。 使用Docker构建PaddlePaddle的文档，需要在系统里先安装好Docker工具包。Docker安装请参考 `Docker的官网 `_ 。安装好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/ diff --git a/paddle/scripts/docker/build.sh b/paddle/scripts/docker/build.sh index 73f885c1e7..6fce3b73dc 100644 --- a/paddle/scripts/docker/build.sh +++ b/paddle/scripts/docker/build.sh @@ -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 ? diff --git a/paddle/scripts/tools/build_docs/build_docs.sh b/paddle/scripts/tools/build_docs/build_docs.sh index fb8c26a69a..61db773d88 100755 --- a/paddle/scripts/tools/build_docs/build_docs.sh +++ b/paddle/scripts/tools/build_docs/build_docs.sh @@ -1,3 +1,37 @@ #!/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] []" + 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 From b4e459b99c17543526f099c81badfdc0fdc8ef42 Mon Sep 17 00:00:00 2001 From: qijun Date: Tue, 25 Apr 2017 13:57:21 +0800 Subject: [PATCH 7/9] update wirte_docs_cn.rst --- doc/howto/dev/write_docs_cn.rst | 26 +++++++++---------- paddle/scripts/docker/build.sh | 4 +-- paddle/scripts/tools/build_docs/build_docs.sh | 13 +++++----- 3 files changed, 21 insertions(+), 22 deletions(-) diff --git a/doc/howto/dev/write_docs_cn.rst b/doc/howto/dev/write_docs_cn.rst index c8dd3d507f..0b93f3fa6a 100644 --- a/doc/howto/dev/write_docs_cn.rst +++ b/doc/howto/dev/write_docs_cn.rst @@ -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即可访问本地文档。 diff --git a/paddle/scripts/docker/build.sh b/paddle/scripts/docker/build.sh index 6fce3b73dc..959cdd14f8 100644 --- a/paddle/scripts/docker/build.sh +++ b/paddle/scripts/docker/build.sh @@ -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 diff --git a/paddle/scripts/tools/build_docs/build_docs.sh b/paddle/scripts/tools/build_docs/build_docs.sh index 61db773d88..99b927b865 100755 --- a/paddle/scripts/tools/build_docs/build_docs.sh +++ b/paddle/scripts/tools/build_docs/build_docs.sh @@ -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 $PADDLE_SOURCE_DIR:/paddle \ + docker run --rm -v $PWD/../../../../:/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 ;; From 9e11c20f91117c57a20cdbc49587c8229c5e7274 Mon Sep 17 00:00:00 2001 From: qijun Date: Tue, 25 Apr 2017 14:55:36 +0800 Subject: [PATCH 8/9] fix bug --- paddle/scripts/tools/build_docs/build_docs.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/paddle/scripts/tools/build_docs/build_docs.sh b/paddle/scripts/tools/build_docs/build_docs.sh index 99b927b865..00123dcb87 100755 --- a/paddle/scripts/tools/build_docs/build_docs.sh +++ b/paddle/scripts/tools/build_docs/build_docs.sh @@ -22,9 +22,9 @@ case "$1" in pushd $PADDLE_SOURCE_DIR/build_doc cmake .. -DWITH_DOC=ON make paddle_docs paddle_docs_cn + popd 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 ;; "--help") From 99e241ba17a90ed833ce4e3f61829d82983be482 Mon Sep 17 00:00:00 2001 From: qijun Date: Tue, 25 Apr 2017 15:21:38 +0800 Subject: [PATCH 9/9] update doc --- doc/howto/dev/write_docs_cn.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/howto/dev/write_docs_cn.rst b/doc/howto/dev/write_docs_cn.rst index 0b93f3fa6a..d536f53abc 100644 --- a/doc/howto/dev/write_docs_cn.rst +++ b/doc/howto/dev/write_docs_cn.rst @@ -68,6 +68,7 @@ PaddlePaddle文档使用 `sphinx`_ 自动生成，用户可以参考sphinx教程 如何更新www.paddlepaddle.org文档 ================================ +开发者给PaddlePaddle代码增加的注释以PR的形式提交到github中，提交方式可参见 `贡献文档 `_ 。 目前PaddlePaddle的develop分支的文档是自动触发更新的，用户可以分别查看最新的 `中文文档 `_ 和 `英文文档 `_ 。