Update write docs cn by jetfuel · Pull Request #6014 · PaddlePaddle/Paddle

jetfuel · 2017-11-29T01:29:02Z

Add dev/contribute_to_paddle_cn.md onto navigation link

Update the write_docs_en.rst and write_docs_cn.rst to include how to run the documentation viewer tool without Docker

Reference issue: #5959

… tool

Update the write_docs_en.rst and write_docs_cn.rst to include how to run the documentation viewer tool without Docker Add dev/contribute_to_paddle_cn.md onto navigation link

luotao1 · 2017-12-02T02:41:21Z

doc/howto/index_cn.rst

 ..  toctree::
  :maxdepth: 1

+  dev/build_cn.rst


22行已经在最新的develop分支里删了
https://github.com/PaddlePaddle/Paddle/pull/5943/files#diff-daf8d7dd10a25feb0fcc8d605bd43e1f
请更新代码

luotao1 · 2017-12-02T02:41:59Z

doc/howto/dev/write_docs_cn.rst

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


编役-》编译

luotao1 · 2017-12-02T02:42:38Z

doc/howto/dev/write_docs_cn.rst

+    python manage.py runserver
+
+之后再用网页连到http://localhost:8000就可以在网页上生成需要的文档。
+想了解更多关於 PaddlePaddle.org 工具，可以 `点击这里 <https://github.com/PaddlePaddle/PaddlePaddle.org/blob/develop/README.cn.md>`_ 。


关於-》关于

这句中文有点不太通顺吧，改成想了解更多PaddlePaddle.org工具的详细信息？

luotao1 · 2017-12-02T02:56:32Z

doc/howto/dev/write_docs_cn.rst

+    cd paddlepaddle
+    git clone [email protected]:PaddlePaddle/Paddle.git
+    git clone [email protected]:PaddlePaddle/book.git
+    git clone [email protected]:PaddlePaddle/models.git


如果用户只想修改一个repo下的内容，是不是下载一个repo就够了呢？还是目前不支持单独查看的功能呢

clone链接建议写https链接吧，这样用户不需要有github账号、也不需要配置sshkey就能直接clone。

另外，这里漏掉了Mobile这个repo。

@luotao1 對的，只要下載一個 repo 就夠。我擺上大部分的Repos 是希望用戶可以直接copy and paste 來開始

luotao1 · 2017-12-02T02:56:55Z

doc/howto/dev/write_docs_cn.rst

+之后再用网页连到http://localhost:8000就可以在网页上生成需要的文档。
+想了解更多关於 PaddlePaddle.org 工具，可以 `点击这里 <https://github.com/PaddlePaddle/PaddlePaddle.org/blob/develop/README.cn.md>`_ 。

 使用Docker构建


目前：“使用Docker构建”和“直接构建”都是对paddle/doc下的所有文档（除了op文档，使用printer_operator_docs命令）进行构建，而且使用的是老的doc_theme，即按照这些命令跑出来的是http://doc.paddlepaddle.org/develop/doc/。
那么这两小节怎么处理呢？

编译命令的话：可以后续在paddle_docs加上编译op文档的命令；

但显示的话，怎么做呢？

也就是上面那个问题：如果用户只想修改一个repo下的内容，要怎么看呢？

viewer tool 裡有選項，可以單獨編譯單一的 repo.

luotao1 · 2017-12-02T02:57:23Z

doc/howto/dev/write_docs_cn.rst

@@ -52,12 +90,12 @@ PaddlePaddle文档使用 `sphinx`_ 自动生成，用户可以参考sphinx教程



如何更新文档主题：这一节可以删了，现在已经不使用doc_theme下的前端网页设计文件了。doc_theme文件夹后续也会删除。

luotao1 · 2017-12-02T03:06:03Z

doc/howto/dev/write_docs_cn.rst

@@ -8,7 +8,45 @@ PaddlePaddle的文档包括英文文档 ``doc`` 和中文文档 ``doc_cn`` 两
 如何构建文档


如何贡献/修改文档：
目前的文档包括：paddlepaddle/doc, book, models。第5行表述的只是paddlepaddle/doc。所以第5行是否要更新下？

此外：operator的文档也是放在doc/目录下么

是的，operator的文档也是放在doc/目录下

Xreki · 2017-12-04T07:13:19Z

doc/howto/dev/write_docs_cn.rst

+    cd paddlepaddle
+    git clone [email protected]:PaddlePaddle/Paddle.git
+    git clone [email protected]:PaddlePaddle/book.git
+    git clone [email protected]:PaddlePaddle/models.git


clone链接建议写https链接吧，这样用户不需要有github账号、也不需要配置sshkey就能直接clone。

另外，这里漏掉了Mobile这个repo。

Xreki · 2017-12-04T07:15:17Z

doc/howto/dev/write_docs_cn.rst

+    git clone [email protected]:PaddlePaddle/book.git
+    git clone [email protected]:PaddlePaddle/models.git
+
+    docker run -it -p 8000:8000 paddlepaddle/paddlepaddle.org:latest


这里应该是docker run -it -p 8000:8000 -v $PWD:/var/content paddlepaddle/paddlepaddle.org:latest，不然本地的修改无法预览。

因為是在docker 與文件 repo 是在同一個 parent folder, 所以可以修改文件。

文档这里应该是有typo哦，没有-v $PWD:/var/content，我昨天试了很久，本地修改都没生效。后来去看了PaddlePaddle.org里面的README，才发现是因为没有用-v $PWD:/var/content映射本地文件。

@Xreki 哇，感謝提出這一點。剛剛在跑了一次，也遇到一樣的問題。我更新了文件。現在應該是對的了

Xreki · 2017-12-04T07:19:21Z

doc/howto/dev/write_docs_cn.rst

+    git clone [email protected]:PaddlePaddle/book.git
+    git clone [email protected]:PaddlePaddle/models.git
+    git clone [email protected]:PaddlePaddle/PaddlePaddle.org.git
+    export CONTENT_DIR=<path_to_paddlepaddle_working_directory> 


应该对CONTENT_DIR介绍一下，path_to_paddlepaddle_working_directory我也不知道应该是哪个路径

Xreki · 2017-12-04T07:22:23Z

doc/howto/dev/write_docs_cn.rst

+    python manage.py runserver
+
+之后再用网页连到http://localhost:8000就可以在网页上生成需要的文档。
+想了解更多关於 PaddlePaddle.org 工具，可以 `点击这里 <https://github.com/PaddlePaddle/PaddlePaddle.org/blob/develop/README.cn.md>`_ 。


这句中文有点不太通顺吧，改成想了解更多PaddlePaddle.org工具的详细信息？

Change the instructions to use https instead of SSH

luotao1

LGTM

jetfuel added 2 commits November 27, 2017 19:22

update the write_docs_cn.rst to include using paddlepaddle.org viewer…

ed4810e

… tool

Add write_docs_en.rst for English version

2488b81

Update the write_docs_en.rst and write_docs_cn.rst to include how to run the documentation viewer tool without Docker Add dev/contribute_to_paddle_cn.md onto navigation link

jetfuel self-assigned this Nov 29, 2017

jetfuel requested a review from luotao1 November 29, 2017 01:29

luotao1 mentioned this pull request Nov 29, 2017

How long can I see the updated document in website After merge the PR #6045

Closed

Merge branch 'develop' into updateWriteDocsCN

048cc30

luotao1 reviewed Dec 2, 2017

View reviewed changes

Xreki mentioned this pull request Dec 4, 2017

Translate the iOS build doc #6180

Closed

Xreki reviewed Dec 4, 2017

View reviewed changes

jetfuel added 3 commits December 4, 2017 12:09

Provide more details on the CONTENT_DIR.

33fe741

Change the instructions to use https instead of SSH

Merge branch 'develop' into updateWriteDocsCN

a061a85

Update the incorrect docker commands. Should always specify -v flag.

576c41b

luotao1 approved these changes Dec 5, 2017

View reviewed changes

luotao1 merged commit 70ee79c into develop Dec 5, 2017

luotao1 deleted the updateWriteDocsCN branch December 8, 2017 06:46

		@@ -52,12 +90,12 @@ PaddlePaddle文档使用 `sphinx`_ 自动生成，用户可以参考sphinx教程

		@@ -8,7 +8,45 @@ PaddlePaddle的文档包括英文文档 ``doc`` 和中文文档 ``doc_cn`` 两
		如何构建文档

Comments

Conversation

jetfuel commented Nov 29, 2017

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!

luotao1 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants