Adjust some contents

wangkuiyi-patch-2
weixing02 7 years ago
parent 599abc4642
commit 9bec0d26db

@ -81,13 +81,13 @@ PaddlePaddle.org工具可以配合Docker使用需要在系统里先安装好D
注:上述命令把当前目录(源码根目录)映射为 container 里的 :code:`/paddle` 目录。 注:上述命令把当前目录(源码根目录)映射为 container 里的 :code:`/paddle` 目录。
编译完成后,进入 ``paddle/build/doc/v2`` 目录,该目录下生成了 ``cn/html/````en/html`` 以及 ``api/en/html`` 共三个子目录,分别进入这些目录下,执行以下命令: 编译完成后,会产生 ``doc/v2````doc/fluid`` 两个目录,在这两个目录下分别都生成 ``cn/html/````en/html`` ``api/en/html`` 共三个子目录,分别进入这些目录下,执行以下命令:
.. code-block:: bash .. code-block:: bash
python -m SimpleHTTPServer 8088 python -m SimpleHTTPServer 8088
在浏览器中输入http://localhost:8088就可以看到编译生成的中/英文的文档页面和英文的API页面。 在浏览器中输入 http://localhost:8088 就可以看到编译生成``v2````fluid`` 两种版本的中/英文的文档页面和英文的API页面。
如果不想使用Docker也可以使用以下命令直接构建PaddlePaddle文档 如果不想使用Docker也可以使用以下命令直接构建PaddlePaddle文档
@ -107,13 +107,13 @@ PaddlePaddle.org工具可以配合Docker使用需要在系统里先安装好D
其中$processors代表启动和CPU核一样多的进程来并行编译可以根据本机的CPU核数设置相应的值。 其中$processors代表启动和CPU核一样多的进程来并行编译可以根据本机的CPU核数设置相应的值。
编译完成后,会产生 ``doc/v2````doc/fluid`` 两个目录,如果选择构建文档则会在这两个目录下分别都生成 ``cn/html/````en/html`` 两个子目录选择构建API则会在这两个目录下分别生成 ``api/en/html`` 目录,分别进入这些子目录下,执行以下命令: 编译完成后,同样会产生 ``doc/v2````doc/fluid`` 两个目录,如果选择构建文档则会在这两个目录下分别都生成 ``cn/html/````en/html`` 两个子目录选择构建API则会在这两个目录下分别生成 ``api/en/html`` 目录,分别进入这些子目录下,执行以下命令:
.. code-block:: bash .. code-block:: bash
python -m SimpleHTTPServer 8088 python -m SimpleHTTPServer 8088
在浏览器中输入 http://localhost:8088 就可以看到编译生成的 ``v2````fluid`` 两种版本的中/英文的文档页面和英文的API页面,下图为生成的 ``v2`` 英文文档首页示例。注意示例中由于使用了sphinx的原始主题所以页面的风格与官网并不一致但这并不影响开发者进行调试。 在浏览器中输入 http://localhost:8088 就可以看到编译生成的 ``v2````fluid`` 两种版本的中/英文的文档页面和英文的API页面下图为生成的 ``v2`` 英文文档首页示例。注意示例中由于使用了sphinx的原始主题所以页面的风格与官网并不一致但这并不影响开发者进行调试。
.. image:: src/doc_en.png .. image:: src/doc_en.png
:align: center :align: center

@ -84,13 +84,13 @@ Build PaddlePaddle's documentation with Dockeryou need to install Docker firs
Note: The above commands maps the current directory (source root directory) to the :code:`/paddle` directory in the container. Note: The above commands maps the current directory (source root directory) to the :code:`/paddle` directory in the container.
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: 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:
.. code-block:: bash .. code-block:: bash
python -m SimpleHTTPServer 8088 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. 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.
If you do not wish to use Docker, you can also use the following commands to directly build the PaddlePaddle documentation. If you do not wish to use Docker, you can also use the following commands to directly build the PaddlePaddle documentation.
@ -111,7 +111,7 @@ If you do not wish to use Docker, you can also use the following commands to dir
$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. $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.
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 APIsa subdirectory ``api/en/html`` will be generated. Please enter these directories respectively and execute the following commands: 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 APIsa subdirectory ``api/en/html`` will be generated. Please enter these directories respectively and execute the following commands:
.. code-block:: bash .. code-block:: bash

Loading…
Cancel
Save