Adjust some contents in write_docs_en.rst for Contribue Documentation #9147

weixing02 · 2018-03-16T03:24:27Z

No description provided.

… doc_en Merge branch develop

luotao1 · 2018-03-16T12:55:04Z

doc/v2/dev/write_docs_en.rst

-This is the recommended method to build documentation. It can compile documentation and preview the documentation in a web browser.
+With PaddlePaddle.org tool
+---------------------------
+This is the recommended method to build documentation, because it can automatically compile the documentation and preview the documentation directly in the web page, it should be noted that, in other ways, although you can preview the documentation, but the style of the documentation and the official website documentation is inconsistent, while Compiling with the PaddlePaddle.org tool produces a preview that is consistent with the official website documentation style.


Note that, in other ways, although you can preview the documentation, its style s inconsistent with the official website. While compiling with the PaddlePaddle.org tool produces a preview that is consistent with the official website documentation style.

… doc_en Merge branch develop

abhinavarora · 2018-03-19T17:09:40Z

doc/v2/dev/write_docs_en.rst


-We recommend using PaddlePaddle.org tool to build documentation
+PaddlePaddle's documentation is built in two ways: using the PaddlePaddle.org tool and not using the PaddlePaddle.org tool. Both methods have their own advantages. The former facilitates previewing, while the latter facilitates debugging by the developer. And we could chose to build the documentation with docker or without docker in each way.


Lets make this sentence: PaddlePaddle's documentation is built in two ways: using the PaddlePaddle.org tool and without using it.

Drop the And in the last sentence. The sentence will be:

We could choose to build the documentation with Docker or without it in each of the above ways.

abhinavarora · 2018-03-19T17:11:49Z

doc/v2/dev/write_docs_en.rst

-Use PaddlePaddle.org tool
--------------
-This is the recommended method to build documentation. It can compile documentation and preview the documentation in a web browser.
+With PaddlePaddle.org tool


With -> Using

abhinavarora · 2018-03-19T17:12:25Z

doc/v2/dev/write_docs_en.rst

-This is the recommended method to build documentation. It can compile documentation and preview the documentation in a web browser.
+With PaddlePaddle.org tool
+---------------------------
+This is the recommended method to build documentation, because it can automatically compile the documentation and preview the documentation directly in the web page. Note that, in other ways, although you can preview the documentation, its style is inconsistent with the official website. While compiling with the PaddlePaddle.org tool produces a preview that is consistent with the official website documentation style.


directly in the web page -> directly in a web page

I think the last part of this paragraph should be as follows:

Note that, although you can preview the documentation in other ways, its style may not be consistent with the official website. Compiling with the PaddlePaddle.org tool produces a preview that will be consistent with the official website documentation style.

abhinavarora · 2018-03-19T17:14:41Z

doc/v2/dev/write_docs_en.rst


-The tool uses Docker, please install it on your system. Please check Docker official website on how to install Docker. You may use the following commands to activate the tool
+The PaddlePaddle.org tool can be used with Docker and Docker needs to be installed first. Please refer to the `Docker's official website <https://docs.docker.com/>`_ on how to install Docker. After installing Docker, you may use the following command to activate the tool


Drop the the
Please refer to the Docker's -> Please refer to Docker's

abhinavarora · 2018-03-19T17:15:15Z

doc/v2/dev/write_docs_en.rst

@@ -33,7 +32,7 @@ The tool uses Docker, please install it on your system. Please check Docker offi
    docker run -it -p 8000:8000 -v `pwd`:/var/content paddlepaddle/paddlepaddle.org:latest

 Note: PaddlePaddle.org will read the content repos specified in the -v (volume) flag of the docker run command
-Use a web browser and navigate to http://localhost:8000, click the buttons to compile the documentation
+Use a web browser and navigate to http://localhost:8000, click the buttons to compile the documentation.


navigate to http://localhost:8000, click the -> navigate to http://localhost:8000. Click the

abhinavarora · 2018-03-19T17:16:50Z

doc/v2/dev/write_docs_en.rst

 Use a web browser and navigate to http://localhost:8000, click the buttons to compile the documentation
 The compiled documentations will be stored in <paddlepaddle working directory>/.ppo_workspace/content

-If you want to learn more on the PaddlePaddle.org, please `click here <https://github.com/PaddlePaddle/PaddlePaddle.org/blob/develop/README.md>`_ 。
+Please `click here <https://github.com/PaddlePaddle/PaddlePaddle.org/blob/develop/README.md>`_ to get more informations about PaddlePaddle.org tool。


to get more informations about PaddlePaddle.org tool -> for more information about the PaddlePaddle.org tool

abhinavarora · 2018-03-19T17:17:39Z

doc/v2/dev/write_docs_en.rst

+Please `click here <https://github.com/PaddlePaddle/PaddlePaddle.org/blob/develop/README.md>`_ to get more informations about PaddlePaddle.org tool。
+
+
+Without PaddlePaddle.org tool


The title should be

Manually Building the Documentation

abhinavarora · 2018-03-19T17:18:04Z

doc/v2/dev/write_docs_en.rst

+
+[TBD]
+
+If you do not wish to use Docker, you can also use the following command to directly build the PaddlePaddle documentation.


command -> commands

abhinavarora · 2018-03-19T17:26:15Z

Thank you for the PR. I have made some suggestions on the grammar and sentence structure for some sentences. Please let me know if you have any questions.

luotao1

LGTM

luotao1 · 2018-03-20T07:38:53Z

doc/v2/dev/write_docs_en.rst

+
+   python -m SimpleHTTPServer 8088
+
+Use a web browser and navigate to http://localhost:8000, you could see the compiled Chinese/English documents page and the English APIs page. The following figure is an example of the built English documents home page. Note that due to the sphinx's original theme used in the example, the style of the page is not consistent with the official website, but this does not affect the developer's debugging.


http://localhost:8088

luotao1 · 2018-03-20T07:40:25Z

doc/v2/dev/write_docs_cn.rst


 如何构建文档
 ============

 PaddlePaddle的文档构建有两种方式，分别为使用paddlepaddle.org工具和不使用paddlepaddle.org工具，两种方式都有各自的优点，前者方便预览，后者方便开发者进行调试。这两种方式中又分别有使用docker和不使用docker的两种构建方法。

+我们建议使用PaddlePaddle.org工具来构建文档。


35行：之后再用网页连到http://localhost:8000 （后面加个空格，这样会显示成网址效果）
同60行。

… doc_en Merge branch develop

* commit '9c35b0dc1ba0ace5acf721685802a21045ea1249': (36 commits) Fix dist compile error (PaddlePaddle#9320) Fix bug for backward tanspiler when using parallel_do operator. (PaddlePaddle#9282) update fix transpiler bug Update index_en.rst (PaddlePaddle#9286) "fix mixed_vector bug" (PaddlePaddle#9319) Update index_en.rst (PaddlePaddle#9280) Adjust some contents in write_docs_en.rst for Contribue Documentation (PaddlePaddle#9147) CMake refine for HIP support. Fix CI. Reuduce memory copy when communication between trainer and pserver. (PaddlePaddle#9271) Modified build.sh and remove build_doc.sh fix doc Enhance device context pool (PaddlePaddle#9293) Device blobs are created only in training. Added testing attribute Shrink batch_norm_grad's inputs updates prepare and create op before run wip small fix initial commit ... # Conflicts: # cmake/external/eigen.cmake

weixing02 added 6 commits March 16, 2018 10:45

Add some contents

c04000d

Adjust the content of the English version

335d0e6

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

72ad688

… doc_en Merge branch develop

Fix some error, replace word generate with build

f77f54f

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

21869e6

… doc_en Merge branch develop

Replace document with documentation

cacd49a

luotao1 reviewed Mar 16, 2018

View reviewed changes

luotao1 requested a review from abhinavarora March 16, 2018 12:56

weixing02 added 2 commits March 19, 2018 15:14

Adjust contents

30fb277

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

e15fbe3

… doc_en Merge branch develop

abhinavarora suggested changes Mar 19, 2018

View reviewed changes

Fix some grammar and sentence structure error

34927cd

luotao1 previously approved these changes Mar 20, 2018

View reviewed changes

luotao1 reviewed Mar 20, 2018

View reviewed changes

weixing02 added 2 commits March 20, 2018 16:00

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

f1a390a

… doc_en Merge branch develop

Make links more visible

e69cf08

weixing02 dismissed luotao1’s stale review via e69cf08 March 20, 2018 08:03

abhinavarora approved these changes Mar 22, 2018

View reviewed changes

abhinavarora merged commit ab5ecdf into PaddlePaddle:develop Mar 22, 2018

weixing02 deleted the doc_en branch March 22, 2018 05:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adjust some contents in write_docs_en.rst for Contribue Documentation #9147

Adjust some contents in write_docs_en.rst for Contribue Documentation #9147

weixing02 commented Mar 16, 2018

luotao1 Mar 16, 2018

weixing02 Mar 19, 2018

abhinavarora Mar 19, 2018

abhinavarora Mar 19, 2018

weixing02 Mar 20, 2018

abhinavarora Mar 19, 2018

weixing02 Mar 20, 2018

abhinavarora Mar 19, 2018

abhinavarora Mar 19, 2018

weixing02 Mar 20, 2018

abhinavarora Mar 19, 2018

weixing02 Mar 20, 2018

abhinavarora Mar 19, 2018

weixing02 Mar 20, 2018

abhinavarora Mar 19, 2018

weixing02 Mar 20, 2018

abhinavarora Mar 19, 2018

weixing02 Mar 20, 2018

abhinavarora Mar 19, 2018

weixing02 Mar 20, 2018

abhinavarora commented Mar 19, 2018

luotao1 left a comment

luotao1 Mar 20, 2018

weixing02 Mar 20, 2018

luotao1 Mar 20, 2018

weixing02 Mar 20, 2018


		We recommend using PaddlePaddle.org tool to build documentation
		PaddlePaddle's documentation is built in two ways: using the PaddlePaddle.org tool and not using the PaddlePaddle.org tool. Both methods have their own advantages. The former facilitates previewing, while the latter facilitates debugging by the developer. And we could chose to build the documentation with docker or without docker in each way.


		The tool uses Docker, please install it on your system. Please check Docker official website on how to install Docker. You may use the following commands to activate the tool
		The PaddlePaddle.org tool can be used with Docker and Docker needs to be installed first. Please refer to the `Docker's official website <https://docs.docker.com/>`_ on how to install Docker. After installing Docker, you may use the following command to activate the tool

		Please `click here <https://github.com/PaddlePaddle/PaddlePaddle.org/blob/develop/README.md>`_ to get more informations about PaddlePaddle.org tool。


		Without PaddlePaddle.org tool


		[TBD]

		If you do not wish to use Docker, you can also use the following command to directly build the PaddlePaddle documentation.


		python -m SimpleHTTPServer 8088

		Use a web browser and navigate to http://localhost:8000, you could see the compiled Chinese/English documents page and the English APIs page. The following figure is an example of the built English documents home page. Note that due to the sphinx's original theme used in the example, the style of the page is not consistent with the official website, but this does not affect the developer's debugging.

Adjust some contents in write_docs_en.rst for Contribue Documentation #9147

Adjust some contents in write_docs_en.rst for Contribue Documentation #9147

Conversation

weixing02 commented Mar 16, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abhinavarora commented Mar 19, 2018

luotao1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment