Add contents for manully build documentation(cn version) #9298
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
luotao1
reviewed
Mar 21, 2018
doc/v2/dev/write_docs_cn.rst
Outdated
| .. code-block:: bash | ||
|
|
||
| mkdir paddle | ||
| cd paddle |
There was a problem hiding this comment.
mkdir paddle
cd paddle
文档里面所有的都可以去掉了，显得有点多余。
doc/v2/dev/write_docs_cn.rst
Outdated
|
|
||
| # 从源码中构建可用于编译PaddlePaddle文档的Docker镜像 | ||
| docker build -t paddle:dev . | ||
| docker run -it -v $PWD:/paddle -e "WITH_GPU=OFF" -e "WITH_TESTING=OFF" paddle:dev /bin/bash |
There was a problem hiding this comment.
78行里不需要 -e "WITH_DOC=ON"么，build.sh里面这个开关默认是关闭的。
added 2 commits
March 22, 2018 11:21
… build_manually Merge branch develop
luotao1
reviewed
Mar 22, 2018
doc/v2/dev/write_docs_cn.rst
Outdated
| @@ -18,9 +18,6 @@ PaddlePaddle.org工具可以配合Docker使用，需要在系统里先安装好D | |||
|
|
|||
| .. code-block:: bash | |||
There was a problem hiding this comment.
paddlepaddle.org里面的mkdir和cd需要留下。
… build_manually Merge branch 'develop'
luotao1
reviewed
Mar 30, 2018
doc/v2/dev/write_docs_cn.rst
Outdated
| @@ -18,9 +18,6 @@ PaddlePaddle.org工具可以配合Docker使用，需要在系统里先安装好D | |||
|
|
|||
| .. code-block:: bash | |||
doc/v2/dev/write_docs_cn.rst
Outdated
|
|
||
| [TBD] | ||
| 在浏览器中输入http://localhost:8088就可以看到编译生成的中/英文的文档页面和英文的API页面。 |
There was a problem hiding this comment.
http://localhost:8088 前后可以加空格，变成网址格式。
added 3 commits
March 30, 2018 19:12
… build_manually Merge branch develop
…into build_manually Merge
luotao1
reviewed
Mar 30, 2018
doc/v2/dev/write_docs_cn.rst
Outdated
|
|
||
| 注：上述命令把当前目录（源码根目录）映射为 container 里的 :code:`/paddle` 目录。 | ||
|
|
||
| 编译完成后，进入 ``paddle/build/doc/v2`` 目录，该目录下生成了 ``cn/html/`` 、 ``en/html`` 以及 ``api/en/html`` 共三个子目录，分别进入这些目录下，执行以下命令： |
There was a problem hiding this comment.
使用build.sh脚本，现在也可以编译出fluid目录了吧。
84-90行内容，与110-116行内容一样，是否保留一处即可。
There was a problem hiding this comment.
用户可能会根据教程选择一种方法按部就班地执行，选择了一种方法就忽略其它方法的内容了，并且两种构建方式还是有点不同，所以虽然有点冗余，但是选择保留会不会好一些呢
There was a problem hiding this comment.
还是有点冗余。如果改成这样会不会好点？
- 使用PaddlePaddle.org工具
- 使用Docker工具
- 使用Django框架
- 预览效果（等预览工具完成后补上）
- 使用PaddlePaddle.org工具
- 使用Docker工具
- 直接构建
- 预览效果
added 5 commits
March 30, 2018 21:12
… build_manually Merge branch develop
… build_manually Merge branch develop
… build_manually Merge branch develop
luotao1
approved these changes
Apr 11, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add some contents on how to use docker to manually build documentation(without using PaddlePaddle.org tool)