Skip to content

Commit 9bec0d2

Browse files
author
weixing02
committed
Adjust some contents
1 parent 599abc4 commit 9bec0d2

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

doc/v2/dev/write_docs_cn.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,13 +81,13 @@ PaddlePaddle.org工具可以配合Docker使用,需要在系统里先安装好D
8181
8282
注:上述命令把当前目录(源码根目录)映射为 container 里的 :code:`/paddle` 目录。
8383

84-
编译完成后,进入 ``paddle/build/doc/v2`` 目录,该目录下生成了 ``cn/html/`` 、 ``en/html`` 以及 ``api/en/html`` 共三个子目录,分别进入这些目录下,执行以下命令:
84+
编译完成后,会产生 ``doc/v2`` 和 ``doc/fluid`` 两个目录,在这两个目录下分别都生成 ``cn/html/`` 、 ``en/html`` ``api/en/html`` 共三个子目录,分别进入这些目录下,执行以下命令:
8585

8686
.. code-block:: bash
8787
8888
python -m SimpleHTTPServer 8088
8989
90-
在浏览器中输入http://localhost:8088就可以看到编译生成的中/英文的文档页面和英文的API页面。
90+
在浏览器中输入 http://localhost:8088 就可以看到编译生成的 ``v2`` 和 ``fluid`` 两种版本的中/英文的文档页面和英文的API页面。
9191

9292
如果不想使用Docker,也可以使用以下命令直接构建PaddlePaddle文档,即
9393

@@ -107,13 +107,13 @@ PaddlePaddle.org工具可以配合Docker使用,需要在系统里先安装好D
107107
108108
其中$processors代表启动和CPU核一样多的进程来并行编译,可以根据本机的CPU核数设置相应的值。
109109

110-
编译完成后,会产生 ``doc/v2`` 和 ``doc/fluid`` 两个目录,如果选择构建文档则会在这两个目录下分别都生成 ``cn/html/`` 、 ``en/html`` 两个子目录,选择构建API则会在这两个目录下分别生成 ``api/en/html`` 目录,分别进入这些子目录下,执行以下命令:
110+
编译完成后,同样会产生 ``doc/v2`` 和 ``doc/fluid`` 两个目录,如果选择构建文档则会在这两个目录下分别都生成 ``cn/html/`` 、 ``en/html`` 两个子目录,选择构建API则会在这两个目录下分别生成 ``api/en/html`` 目录,分别进入这些子目录下,执行以下命令:
111111

112112
.. code-block:: bash
113113
114114
python -m SimpleHTTPServer 8088
115115
116-
在浏览器中输入 http://localhost:8088 就可以看到编译生成的 ``v2`` 和 ``fluid`` 两种版本的中/英文的文档页面和英文的API页面,下图为生成的 ``v2`` 英文文档首页示例。注意,示例中由于使用了sphinx的原始主题,所以页面的风格与官网并不一致,但这并不影响开发者进行调试。
116+
在浏览器中输入 http://localhost:8088 就可以看到编译生成的 ``v2`` 和 ``fluid`` 两种版本的中/英文的文档页面和英文的API页面下图为生成的 ``v2`` 英文文档首页示例。注意,示例中由于使用了sphinx的原始主题,所以页面的风格与官网并不一致,但这并不影响开发者进行调试。
117117

118118
.. image:: src/doc_en.png
119119
:align: center

doc/v2/dev/write_docs_en.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,13 +84,13 @@ Build PaddlePaddle's documentation with Docker,you need to install Docker firs
8484
8585
Note: The above commands maps the current directory (source root directory) to the :code:`/paddle` directory in the container.
8686

87-
After compiling, you could enter the ``paddle/build/doc/v2`` directory, where three subdirectories ``cn/html/``, ``en/html`` and ``api/en/html`` are generated. Please enter these directories respectively and execute the following commands:
87+
After compiling, there should be two generated directories: ``doc/v2`` and ``doc/fluid``, where three subdirectories ``cn/html/``, ``en/html`` and ``api/en/html`` are generated. Please enter these directories respectively and execute the following commands:
8888

8989
.. code-block:: bash
9090
9191
python -m SimpleHTTPServer 8088
9292
93-
Use a web browser and navigate to http://localhost:8000, you could see the compiled Chinese/English documents page and the English APIs page.
93+
Use a web browser and navigate to http://localhost:8000, you could see the compiled ``v2`` 's and ``fluid`` 's Chinese/English documents page and English APIs page.
9494

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

@@ -111,7 +111,7 @@ If you do not wish to use Docker, you can also use the following commands to dir
111111
112112
$processors indicates that as many processes as the CPU cores are started to compile in parallel. It should be set according to the number of CPU cores of your machine.
113113

114-
After the compilation is complete, there should be two generated directories: ``doc/v2`` and ``doc/fluid`` . If you chose to build documents, two subdirectories ``cn/html/`` and ``en/html`` will be generated in both two directories. If you chose to build APIs,a subdirectory ``api/en/html`` will be generated. Please enter these directories respectively and execute the following commands:
114+
After compiling, there also should be two generated directories: ``doc/v2`` and ``doc/fluid`` . If you chose to build documents, two subdirectories ``cn/html/`` and ``en/html`` will be generated in both two directories. If you chose to build APIs,a subdirectory ``api/en/html`` will be generated. Please enter these directories respectively and execute the following commands:
115115

116116
.. code-block:: bash
117117

0 commit comments

Comments
 (0)