From b4e459b99c17543526f099c81badfdc0fdc8ef42 Mon Sep 17 00:00:00 2001 From: qijun Date: Tue, 25 Apr 2017 13:57:21 +0800 Subject: [PATCH] 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 c8dd3d507..0b93f3fa6 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 6fce3b73d..959cdd14f 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 61db773d8..99b927b86 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 ;; -- GitLab