From 82273f60ca8b4f803792577e6cb2b2a5dc72fb60 Mon Sep 17 00:00:00 2001 From: hedaoyuan Date: Fri, 18 Nov 2016 17:11:38 +0800 Subject: [PATCH] fix how_to_write_docs --- doc_cn/howto/how_to_write_docs/index.rst | 29 ++++++++---------------- 1 file changed, 10 insertions(+), 19 deletions(-) diff --git a/doc_cn/howto/how_to_write_docs/index.rst b/doc_cn/howto/how_to_write_docs/index.rst index 869ef747f9f..a1f983b3405 100644 --- a/doc_cn/howto/how_to_write_docs/index.rst +++ b/doc_cn/howto/how_to_write_docs/index.rst @@ -2,32 +2,19 @@ 如何贡献/修改PaddlePaddle的文档 ############################### -PaddlePaddle的文档使用 `cmake`_ 驱动 `sphinx`_ 生成。公有两个文档，:code:`doc` 和 :code:`doc_cn` 。这两者会在 `cmake`_ 中进行编译，生成后的文档会存储在服务器的 :code:`doc` 和 :code:`doc_cn` 两个目录下。 +PaddlePaddle的文档包括英文文档 ``doc`` 和中文文档 ``doc_cn`` 两个部分。文档都是通过 `cmake`_ 驱动 `sphinx`_ 编译生成，生成后的文档分别存储在编译目录的 ``doc`` 和 ``doc_cn`` 两个子目录下。 -下面分几个部分介绍一下PaddlePaddle文档的贡献方法。 - -如何书写PaddlePaddle的文档 -========================== - -TBD 如何构建PaddlePaddle的文档 ========================== -构建PaddlePaddle文档，需要使用构建Paddle的全部环境。准备这个环境相对来说比较复杂，所以本文档提供两种方式构建PaddlePaddle的文档，即 - -* 使用Docker构建PaddlePaddle的文档 -* 直接构建PaddlePaddle的文档。 - -并且，我们推荐使用Docker来构建PaddlePaddle的文档。 +PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式。构建PaddlePaddle文档需要准备的环境相对较复杂，所以我们推荐使用基于Docker来构建PaddlePaddle的文档。 使用Docker构建PaddlePaddle的文档 -------------------------------- -使用Docker构建PaddlePaddle的文档，首先要求在系统里安装好Docker工具包。安装Docker请参考 `Docker的官网 `_ 。 - -安装好Docker之后可以使用源码目录下的脚本构建文档，即 +使用Docker构建PaddlePaddle的文档，需要在系统里先安装好Docker工具包。Docker安装请参考 `Docker的官网 `_ 。安装好Docker之后可以使用源码目录下的脚本构建文档，即 .. code-block:: bash @@ -35,10 +22,10 @@ TBD cd paddle/scripts/tools/build_docs bash build_docs.sh -执行完这个脚本后，该目录下会生成两个目录，分别是\: +编译完成后，该目录下会生成如下两个子目录\: -* doc 目录，英文文档地址 -* doc_cn 目录，中文文档地址 +* doc 英文文档目录 +* doc_cn 中文文档目录 打开浏览器访问对应目录下的index.html即可访问本地文档。 @@ -52,6 +39,10 @@ TBD TBD +如何书写PaddlePaddle的文档 +========================== + +TBD 如何更新www.paddlepaddle.org文档 ================================ -- GitLab