Skip to content

Commit 9857ff1

Browse files
authored
Merge pull request #9298 from weixing02/build_manually
Add contents for manully build documentation(cn version)
2 parents d52fa26 + 21c7db4 commit 9857ff1

File tree

2 files changed

+55
-22
lines changed

2 files changed

+55
-22
lines changed

doc/v2/dev/write_docs_cn.rst

Lines changed: 27 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -65,39 +65,55 @@ PaddlePaddle.org工具可以配合Docker使用,需要在系统里先安装好D
6565
不使用PaddlePaddle.org工具
6666
--------------------------
6767

68-
使用Docker构建PaddlePaddle的文档,需要在系统里先安装好Docker工具包。Docker安装请参考 `Docker的官网 <https://docs.docker.com/>`_ 。安装好Docker之后可以使用源码目录下的脚本构建文档,即
68+
使用Docker构建PaddlePaddle的文档,需要在系统里先安装好Docker工具包。Docker安装请参考 `Docker的官网 <https://docs.docker.com/>`_ 。该方法与 `从源码编译PaddlePaddle <http://paddlepaddle.org/docs/develop/documentation/zh/build_and_install/build_from_source_cn.html>`_ 相似,通过从源码中构建可用于编译PaddlePaddle文档的Docker镜像并运行,在进入Docker容器后使用源码中的脚本构建PaddlePaddle文档,具体步骤如下:
6969

70-
[TBD]
70+
.. code-block:: bash
71+
72+
git clone https://github.com/PaddlePaddle/Paddle.git
73+
cd Paddle
74+
75+
# 从源码中构建可用于编译PaddlePaddle文档的Docker镜像
76+
docker build -t paddle:dev .
77+
docker run -it -v $PWD:/paddle -e "WITH_GPU=OFF" -e "WITH_TESTING=OFF" -e "WITH_DOC=ON" paddle:dev /bin/bash
78+
79+
# 进入Docker容器后使用build.sh脚本构建PaddlePaddle文档
80+
bash -x /paddle/paddle/scripts/docker/build.sh
81+
82+
注:上述命令把当前目录(源码根目录)映射为 container 里的 :code:`/paddle` 目录。
83+
84+
编译完成后,会产生 ``doc/v2`` 和 ``doc/fluid`` 两个目录,在这两个目录下分别都生成 ``cn/html/`` 、 ``en/html`` 、 ``api/en/html`` 共三个子目录,分别进入这些目录下,执行以下命令:
85+
86+
.. code-block:: bash
87+
88+
python -m SimpleHTTPServer 8088
89+
90+
在浏览器中输入 http://localhost:8088 就可以看到编译生成的 ``v2`` 和 ``fluid`` 两种版本的中/英文的文档页面和英文的API页面。
7191

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

7494
.. code-block:: bash
7595
76-
mkdir paddle
77-
cd paddle
7896
git clone https://github.com/PaddlePaddle/Paddle.git
97+
cd Paddle
7998
mkdir -p build
8099
cd build
81100
cmake .. -DCMAKE_BUILD_TYPE=Release -DWITH_GPU=OFF -DWITH_MKL=OFF -DWITH_DOC=ON
82101
83102
# 如果只需要构建使用文档,则执行以下命令
84-
make -j $processors gen_proto_py
85-
make -j $processors paddle_docs paddle_docs_cn
103+
make -j $processors paddle_docs
86104
87105
# 如果只需要构建API,则执行以下命令
88-
make -j $processors gen_proto_py framework_py_proto
89-
make -j $processors copy_paddle_pybind
90-
make -j $processors paddle_api_docs
106+
make -j $processors paddle_apis
91107
92108
其中$processors代表启动和CPU核一样多的进程来并行编译,可以根据本机的CPU核数设置相应的值。
93109

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

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

102118
.. image:: src/doc_en.png
103119
:align: center

doc/v2/dev/write_docs_en.rst

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -68,39 +68,56 @@ Please `click here <https://github.com/PaddlePaddle/PaddlePaddle.org/blob/develo
6868
Manually Building the Documentation
6969
-------------------------------------
7070

71-
Build PaddlePaddle's documentation with Docker,you need to install Docker first. Please refer to `Docker's official website <https://docs.docker.com/>`_ on how to install Docker. After Docker is installed, you could use the scripts in the source directory to build the documentation.
71+
Build PaddlePaddle's documentation with Docker,you need to install Docker first. Please refer to `Docker's official website <https://docs.docker.com/>`_ on how to install Docker. This method is quite similar to ` Build From Sources <http://paddlepaddle.org/docs/develop/documentation/en/build_and_install/build_from_source_en.html>`_ , by constructing, from source code, a docker image that can be used to build PaddlePaddle documentation. Enter the Docker container and use the script ``build.sh`` in the source directory to build the PaddlePaddle documentation. The specific steps are as follows:
7272

73-
[TBD]
73+
.. code-block:: bash
74+
75+
git clone https://github.com/PaddlePaddle/Paddle.git
76+
cd Paddle
77+
78+
# Construct a docker image from source code
79+
docker build -t paddle:dev .
80+
docker run -it -v $PWD:/paddle -e "WITH_GPU=OFF" -e "WITH_TESTING=OFF" -e "WITH_DOC=ON" paddle:dev /bin/bash
81+
82+
# Use build.sh to build PaddlePaddle documentation
83+
bash -x /paddle/paddle/scripts/docker/build.sh
84+
85+
Note: The above commands maps the current directory (source root directory) to the :code:`/paddle` directory in the container.
86+
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:
88+
89+
.. code-block:: bash
90+
91+
python -m SimpleHTTPServer 8088
92+
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.
7494

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

7797
.. code-block:: bash
7898
79-
mkdir paddle
80-
cd paddle
99+
81100
git clone https://github.com/PaddlePaddle/Paddle.git
101+
cd Paddle
82102
mkdir -p build
83103
cd build
84104
cmake .. -DCMAKE_BUILD_TYPE=Release -DWITH_GPU=OFF -DWITH_MKL=OFF -DWITH_DOC=ON
85105
86106
# If you only need to build documents, use the following commands
87-
make -j $processors gen_proto_py
88-
make -j $processors paddle_docs paddle_docs_cn
107+
make -j $processors paddle_docs
89108
90109
# If you only need to build APIs, use the following commands
91-
make -j $processors gen_proto_py framework_py_proto
92-
make -j $processors copy_paddle_pybind
93-
make -j $processors paddle_api_docs
110+
make -j $processors paddle_apis
94111
95112
$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.
96113

97-
After the compilation is complete, enter the ``doc/v2`` directory. If you chose to build documents, it will generate ``cn/html/`` and ``en/html`` subdirectories under this directory. If you chose to build APIs,it will generate``api/en/html`` subdirectory. 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:
98115

99116
.. code-block:: bash
100117
101118
python -m SimpleHTTPServer 8088
102119
103-
Use a web browser and navigate to http://localhost:8000, you could see the compiled Chinese/English documents page and the English APIs page. The following figure is an example of the built English documents home page. Note that due to the sphinx's original theme used in the example, the style of the page is not consistent with the official website, but this does not affect the developer's debugging.
120+
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. The following figure is an example of the built ``v2`` 's English documents home page. Note that due to the sphinx's original theme used in the example, the style of the page is not consistent with the official website, but this does not affect the developer's debugging.
104121

105122
.. image:: src/doc_en.png
106123
:align: center

0 commit comments

Comments
 (0)