Fixed some outdated contents in Contribute Documentations #9016

weixing02 · 2018-03-13T03:32:19Z

resolve #8993

… doc Branch doc fixed some outdated contents in Contribute Documentations

luotao1

可以先改中文文档，等确定后再改英文文档。

luotao1 · 2018-03-13T03:48:38Z

doc/v2/dev/write_docs_cn.rst

 编译完成之后，会在当前目录生成两个子目录\: doc(英文文档目录)和 doc_cn(中文文档目录)。
 打开浏览器访问对应目录下的index.html即可访问本地文档。

 直接构建


考虑下：如何将直接构建和使用Docker构建合并，即整体分为两种：使用paddlepaddle.org工具，不使用paddlepaddle.org工具。每个里面分（使用docker和不使用docker）。
两种各有优点，前者方便预览，后者方便开发者进行调试。

好的，这样从逻辑上更为合理些，谢谢！

luotao1 · 2018-03-13T03:50:20Z

doc/v2/dev/write_docs_cn.rst

 --------

-如果提示正确，可以执行以下命令编译生成文档，即
+直接构建可以分为两种方式，分别是构建文档和构建API。


直接构建包括构建中英文使用文档（对应官网的http://www.paddlepaddle.org/docs/develop/documentation/zh/getstarted/index_cn.html）
和构建英文API（对应官网的http://www.paddlepaddle.org/docs/develop/api/en/overview.html），语言请重新组织。

luotao1 · 2018-03-13T03:52:15Z

doc/v2/dev/write_docs_cn.rst


-编译完成之后，会在当前目录生成两个子目录\: doc(英文文档目录)和 doc_cn(中文文档目录)。
-打开浏览器访问对应目录下的index.html即可访问本地文档。
+.. code-block:: bash


git clone https://github.com/PaddlePaddle/Paddle.git cd TO_YOUR_PADDLE_CLONE_PATH mkdir -p build cd build cmake .. -DCMAKE_BUILD_TYPE=Release -DWITH_GPU=OFF -DWITH_MKL=OFF -DWITH_DOC=ON

等类似这些命令都要有，对用户来说，需要从第一步开始。
类似paddlepaddle.org工具那样，写出完整的命令。

luotao1 · 2018-03-13T03:57:24Z

doc/v2/dev/write_docs_cn.rst

+   make -j $processors copy_paddle_pybind
+   make -j $processors paddle_api_docs
+
+其中$processors代表启动多少个进程来进行编译，一般取值为1，4或8。


其中$processors代表启动和 CPU 核一样多的进程来并行编译。

luotao1 · 2018-03-13T04:06:25Z

doc/v2/dev/write_docs_cn.rst

-    cmake .. -DCMAKE_BUILD_TYPE=Debug -DWITH_GPU=OFF -DWITH_MKL=OFF -DWITH_DOC=ON
-    make gen_proto_py
-    make paddle_docs paddle_docs_cn
+如果只需要构建文档，可以执行以下命令编译生成文档，即：


84-86行，93-95行可以不用写。具体区分在命令中写出来即可。类似http://www.paddlepaddle.org/docs/develop/documentation/zh/build_and_install/build_from_source_cn.html#build-step 在命令中区分了两种方法。

谢谢！但在命令中使用注释区分会不会不够明显呢

因为除了命令稍有不同外，其他的描述都是类似的。

对应到使用paddlepaddle.org工具时，也只是里面选的按钮不同，其他并无区别。

luotao1 · 2018-03-13T04:07:54Z

doc/v2/dev/write_docs_cn.rst

+
+其中$processors代表启动多少个进程来进行编译，一般取值为1，4或8。
+
+编译完成后，从当前目录进入doc/v2目录，该目录下生成了三个子目录，可以分别进入目录cn/html/、en/html、api/en/html中，执行以下命令，即：


需要说明，构建文档会生成cn/html和en/html目录，构建api会生成api/en/html

luotao1 · 2018-03-13T04:08:52Z

doc/v2/dev/write_docs_cn.rst


+..  image:: doc_en.png
+    :align: center
+    :scale: 60 %


需要放英文页面首页。并说明这是采用sphinx主题生成的，因此和官网的风格不一样，但方便开发者调试。语言请重新组织。

luotao1 · 2018-03-13T04:09:33Z

doc/v2/dev/write_docs_cn.rst

+
+在浏览器中输入http://localhost:8088就可以看到编译生成的中/英文的文档页面和英文的API页面,下图为生成的英文文档页面示例。

+..  image:: doc_en.png


图片请新建一个src目录，统一放在src目录下。

… doc Adjust some contents and create a new folder src to store pictures.

luotao1 · 2018-03-13T12:14:53Z

doc/v2/dev/write_docs_cn.rst


 使用PaddlePaddle.org工具
--------------
+----------------------


15行需要超过14行，才不会报warning，下同。

luotao1 · 2018-03-13T12:18:19Z

doc/v2/dev/write_docs_cn.rst

    sh build_docs.sh

 编译完成之后，会在当前目录生成两个子目录\: doc(英文文档目录)和 doc_cn(中文文档目录)。
 打开浏览器访问对应目录下的index.html即可访问本地文档。


docker这段的描述和命令都不对，可以等下一个PR来进行修改。类似docker run -it -p 8000:8000 -v pwd:/var/content paddlepaddle/paddlepaddle.org:latest的命令。这里可以先把这段删了，改成TBD。

luotao1 · 2018-03-13T12:19:28Z

doc/v2/dev/write_docs_cn.rst

-    make paddle_docs paddle_docs_cn
+   # Clone the content repositories
+   git clone https://github.com/PaddlePaddle/Paddle.git
+   cd TO_YOUR_PADDLE_CLONE_PATH


88-93行：

mkdir paddle cd paddle git clone https://github.com/PaddlePaddle/Paddle.git mkdir -p build

luotao1 · 2018-03-13T12:19:45Z

doc/v2/dev/write_docs_cn.rst

+   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


Debug改成Release

luotao1 · 2018-03-13T12:20:09Z

doc/v2/dev/write_docs_cn.rst

+   make -j $processors copy_paddle_pybind
+   make -j $processors paddle_api_docs
+
+其中$processors代表启动和CPU核一样多的进程来并行编译，一般取值为1，4或8，可以根据本机的CPU核数设置相应的值。


“一般取值为1，4或8”去掉。

luotao1 · 2018-03-13T12:23:51Z

doc/v2/dev/write_docs_cn.rst

 这个是目前推荐的使用方法。除了可以自动编译文档，也可以直接在网页预览文档。

-文件工具是使用Docker，需要在系统里先安装好Docker工具包。Docker安装请参考Docker的官网。安装好Docker之后及可用以下命令启动工具
+PaddlePaddle.org工具可以配合Docker使用，需要在系统里先安装好Docker工具包。Docker安装请参考Docker的官网。安装好Docker之后即可用以下命令启动工具


请参考Docker的官网，官网链接可参考68行。

luotao1 · 2018-03-13T12:27:43Z

doc/v2/dev/write_docs_cn.rst

 PaddlePaddle的文档包括英文文档 ``doc`` 和中文文档 ``doc_cn`` 两个部分。文档都是通过 `cmake`_ 驱动 `sphinx`_ 编译生成，生成后的文档分别存储在编译目录的 ``doc`` 和 ``doc_cn`` 两个子目录下。
 也可以利用PaddlePaddle 工具来编译文档，这个情况下所有的文件会存在整理过的的文件目录 .ppo_workspace/content 下

 如何构建文档


第5-6行改为：PaddlePaddle的文档包括中英文两个部分。文档都是通过 cmake_ 驱动 sphinx_ 编译生成，也可以利用paddlepaddle.org工具来编译和预览文档。

luotao1 · 2018-03-13T12:29:10Z

doc/v2/dev/write_docs_cn.rst

 ============

-PaddlePaddle的文档构建有三种方式。
+PaddlePaddle的文档构建有两种方式。


因为后面两种方式的介绍比较长，因此在11行先对这两种方式说明一下各自的优点。

luotao1 · 2018-03-13T12:29:51Z

doc/v2/dev/write_docs_cn.rst

 使用PaddlePaddle.org工具
--------------
+----------------------
 这个是目前推荐的使用方法。除了可以自动编译文档，也可以直接在网页预览文档。


直接在网页预览文档。（描述不准确，后面那个方式也能预览文档，这儿是预览样式和官网效果一样，语言请重新组织）

luotao1 · 2018-03-13T12:32:39Z

doc/v2/dev/write_docs_cn.rst

+    :align: center
+    :scale: 60 %

 如何书写文档


129行的提交方式参见 贡献文档 <http://www.paddlepaddle.org/docs/develop/documentation/en/howto/dev/contribute_to_paddle_en.html>_
改成：如何贡献代码，并使用正确链接。

… doc Merge branch develop

luotao1

可以对应修改英文文档。

luotao1 · 2018-03-14T11:50:28Z

doc/v2/dev/write_docs_cn.rst

 ============================

-更新的文档以PR的形式提交到github中，提交方式参见 `贡献文档 <http://www.paddlepaddle.org/docs/develop/documentation/en/howto/dev/contribute_to_paddle_en.html>`_ 。
+更新的文档以PR的形式提交到github中，提交方式参见 `如何贡献文档 <http://www.paddlepaddle.org/docs/develop/documentation/zh/dev/write_docs_cn.html>`_ 。


提交方式应该是参加如何贡献代码，并对应修改链接。

luotao1

LGTM!

weixing02 added 2 commits March 13, 2018 11:26

Fix some outdated contents in Contribute Documentations

e1b2408

Merge branch 'develop' of https://github.com/PaddlePaddle/Paddle into…

5b71eef

… doc Branch doc fixed some outdated contents in Contribute Documentations

luotao1 reviewed Mar 13, 2018

View reviewed changes

weixing02 added 4 commits March 13, 2018 18:29

Rollback write_docs_en.rst

0f81a80

Create a new folder to store pictures

6723e1b

Adjust some

070c3b5

Merge branch 'develop' of https://github.com/PaddlePaddle/Paddle into…

678a34c

… doc Adjust some contents and create a new folder src to store pictures.

luotao1 reviewed Mar 13, 2018

View reviewed changes

weixing02 added 4 commits March 14, 2018 11:00

Adjust some contents

cc1650c

Adjust

ca0e324

Merge branch 'develop' of https://github.com/PaddlePaddle/Paddle into…

ce55798

… doc Merge branch develop

Correct links error

3d6a4b6

luotao1 reviewed Mar 14, 2018

View reviewed changes

luotao1 approved these changes Mar 14, 2018

View reviewed changes

luotao1 merged commit 7276366 into PaddlePaddle:develop Mar 14, 2018

weixing02 deleted the doc branch March 14, 2018 15:14


		其中$processors代表启动多少个进程来进行编译，一般取值为1，4或8。

		编译完成后，从当前目录进入doc/v2目录，该目录下生成了三个子目录，可以分别进入目录cn/html/、en/html、api/en/html中，执行以下命令，即：


		在浏览器中输入http://localhost:8088就可以看到编译生成的中/英文的文档页面和英文的API页面,下图为生成的英文文档页面示例。

		.. image:: doc_en.png

Fixed some outdated contents in Contribute Documentations #9016

Fixed some outdated contents in Contribute Documentations #9016

Uh oh!

Conversation

weixing02 commented Mar 13, 2018

Uh oh!

luotao1 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment