From cc1650c9d9159bf6ccc1bc39aaab9b349ea30120 Mon Sep 17 00:00:00 2001
From: weixing02 <564445201@qq.com>
Date: Wed, 14 Mar 2018 11:00:15 +0800
Subject: [PATCH] Adjust some contents
---
doc/v2/dev/write_docs_cn.rst | 46 ++++++++++++------------------------
1 file changed, 15 insertions(+), 31 deletions(-)
diff --git a/doc/v2/dev/write_docs_cn.rst b/doc/v2/dev/write_docs_cn.rst
index 907f9b05dfd..c975b0bb815 100644
--- a/doc/v2/dev/write_docs_cn.rst
+++ b/doc/v2/dev/write_docs_cn.rst
@@ -2,20 +2,19 @@
如何贡献文档
#############
-PaddlePaddle的文档包括英文文档 ``doc`` 和中文文档 ``doc_cn`` 两个部分。文档都是通过 `cmake`_ 驱动 `sphinx`_ 编译生成，生成后的文档分别存储在编译目录的 ``doc`` 和 ``doc_cn`` 两个子目录下。
-也可以利用PaddlePaddle 工具来编译文档，这个情况下所有的文件会存在整理过的的文件目录 .ppo_workspace/content 下
+PaddlePaddle的文档包括中英文两个部分。文档都是通过``cmake``驱动``sphinx``编译生成，也可以利用paddlepaddle.org工具来编译和预览文档。
如何构建文档
============
-PaddlePaddle的文档构建有两种方式。
+PaddlePaddle的文档构建有两种方式，分别为使用paddlepaddle.org工具和不使用paddlepaddle.org工具，两种方式都有各自的优点，前者方便预览，后者方便开发者进行调试。这两种方式中又分别有使用docker和不使用docker的两种构建方法。
使用PaddlePaddle.org工具
-----------------------
-这个是目前推荐的使用方法。除了可以自动编译文档，也可以直接在网页预览文档。
+------------------------
+这个是目前推荐的使用方法。除了可以自动编译文档，还可以直接在网页中预览文档，需要注意的是，采用后续说明的其它方式虽然也可以预览文档，但是文档的样式与官网文档是不一致的，使用PaddlePaddle.org工具进行编译才能产生与官网文档样式一致的预览效果。
-PaddlePaddle.org工具可以配合Docker使用，需要在系统里先安装好Docker工具包。Docker安装请参考Docker的官网。安装好Docker之后即可用以下命令启动工具
+PaddlePaddle.org工具可以配合Docker使用，需要在系统里先安装好Docker工具包。Docker安装请参考 `Docker的官网 `_ 。安装好Docker之后即可用以下命令启动工具
.. code-block:: bash
@@ -63,37 +62,22 @@ PaddlePaddle.org工具可以配合Docker使用，需要在系统里先安装好D
想了解更多PaddlePaddle.org工具的详细信息，可以 `点击这里 `_ 。
不使用PaddlePaddle.org工具
-------------------------
+--------------------------
使用Docker构建PaddlePaddle的文档，需要在系统里先安装好Docker工具包。Docker安装请参考 `Docker的官网 `_ 。安装好Docker之后可以使用源码目录下的脚本构建文档，即
-.. code-block:: bash
-
- mkdir paddlepaddle # Create paddlepaddle working directory
- cd paddlepaddle
-
- # Clone the content repositories
- git clone https://github.com/PaddlePaddle/Paddle.git
- cd TO_YOUR_PADDLE_CLONE_PATH
- cd paddle/scripts/tools/build_docs
- sh build_docs.sh
-
-编译完成之后，会在当前目录生成两个子目录\: doc(英文文档目录)和 doc_cn(中文文档目录)。
-打开浏览器访问对应目录下的index.html即可访问本地文档。
+TBD
如果不想使用Docker，也可以使用以下命令直接构建PaddlePaddle文档，即
.. code-block:: bash
- mkdir paddlepaddle # Create paddlepaddle working directory
- cd paddlepaddle
-
- # Clone the content repositories
+ mkdir paddle
+ cd paddle
git clone https://github.com/PaddlePaddle/Paddle.git
- cd TO_YOUR_PADDLE_CLONE_PATH
mkdir -p build
cd build
- cmake .. -DCMAKE_BUILD_TYPE=Debug -DWITH_GPU=OFF -DWITH_MKL=OFF -DWITH_DOC=ON
+ cmake .. -DCMAKE_BUILD_TYPE=Release -DWITH_GPU=OFF -DWITH_MKL=OFF -DWITH_DOC=ON
# 如果只需要构建使用文档，则执行以下命令
make -j $processors gen_proto_py
@@ -104,9 +88,9 @@ PaddlePaddle.org工具可以配合Docker使用，需要在系统里先安装好D
make -j $processors copy_paddle_pybind
make -j $processors paddle_api_docs
-其中$processors代表启动和CPU核一样多的进程来并行编译，一般取值为1，4或8，可以根据本机的CPU核数设置相应的值。
+其中$processors代表启动和CPU核一样多的进程来并行编译，可以根据本机的CPU核数设置相应的值。
-编译完成后，进入doc/v2目录，如果选择构建文档则会在该目录下生成cn/html/、en/html两个子目录，选择构建API则会生成api/en/html目录，分别进入这些目录下，执行以下命令，即：
+编译完成后，进入``doc/v2``目录，如果选择构建文档则会在该目录下生成``cn/html/``、``en/html``两个子目录，选择构建API则会生成``api/en/html``目录，分别进入这些目录下，执行以下命令：
.. code-block:: bash
@@ -126,9 +110,9 @@ PaddlePaddle文档使用 `sphinx`_ 自动生成，用户可以参考sphinx教程
如何更新www.paddlepaddle.org
============================
-更新的文档以PR的形式提交到github中，提交方式参见 `贡献文档 `_ 。
-目前PaddlePaddle的develop分支的文档是自动触发更新的，用户可以分别查看最新的 `中文文档 `_ 和
-`英文文档 `_ 。
+更新的文档以PR的形式提交到github中，提交方式参见 `如何贡献文档 `_ 。
+目前PaddlePaddle的develop分支的文档是自动触发更新的，用户可以分别查看最新的 `中文文档 `_ 和
+`英文文档 `_ 。
.. _cmake: https://cmake.org/
--
GitLab