提交 e1b24080 编写于 作者: _青葱's avatar _青葱

Fix some outdated contents in Contribute Documentations

上级 6c06841b
...@@ -79,20 +79,40 @@ PaddlePaddle的文档构建有三种方式。 ...@@ -79,20 +79,40 @@ PaddlePaddle的文档构建有三种方式。
直接构建 直接构建
-------- --------
如果提示正确,可以执行以下命令编译生成文档,即 直接构建可以分为两种方式,分别是构建文档和构建API。
.. code-block:: bash - 构建文档
cd TO_YOUR_PADDLE_CLONE_PATH 如果只需要构建文档,可以执行以下命令编译生成文档,即:
mkdir -p build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Debug -DWITH_GPU=OFF -DWITH_MKL=OFF -DWITH_DOC=ON
make gen_proto_py
make paddle_docs paddle_docs_cn
编译完成之后,会在当前目录生成两个子目录\: doc(英文文档目录)和 doc_cn(中文文档目录)。 .. code-block:: bash
打开浏览器访问对应目录下的index.html即可访问本地文档。
make -j $processors gen_proto_py
make -j $processors paddle_docs paddle_docs_cn
- 构建API
如果只需要构建API,则可以执行以下命令编译生成文档,即:
.. code-block:: bash
make -j $processors gen_proto_py framework_py_proto
make -j $processors copy_paddle_pybind
make -j $processors paddle_api_docs
其中$processors代表启动多少个进程来进行编译,一般取值为1,4或8。
编译完成后,从当前目录进入doc/v2目录,该目录下生成了三个子目录,可以分别进入目录cn/html/、en/html、api/en/html中,执行以下命令,即:
.. code-block:: bash
python -m SimpleHTTPServer 8088
在浏览器中输入http://localhost:8088就可以看到编译生成的中/英文的文档页面和英文的API页面,下图为生成的英文文档页面示例。
.. image:: doc_en.png
:align: center
:scale: 60 %
如何书写文档 如何书写文档
============ ============
......
...@@ -63,6 +63,44 @@ The compiled documentations will be stored in <paddlepaddle working directory>/. ...@@ -63,6 +63,44 @@ The compiled documentations will be stored in <paddlepaddle working directory>/.
If you want to learn more on the PaddlePaddle.org, please `click here <https://github.com/PaddlePaddle/PaddlePaddle.org/blob/develop/README.md>`_ 。 If you want to learn more on the PaddlePaddle.org, please `click here <https://github.com/PaddlePaddle/PaddlePaddle.org/blob/develop/README.md>`_ 。
build documentations directly
----------------------------
There's two ways to build documentations directly: build documents and build APIs
- build documents
If you only need to build documents, you can execute the following command to set up:
.. code-block:: bash
make -j $processors gen_proto_py
make -j $processors paddle_docs paddle_docs_cn
- build APIs
If you only need to build APIs, you can execute the following command to set up:
.. code-block:: bash
make -j $processors gen_proto_py framework_py_proto
make -j $processors copy_paddle_pybind
make -j $processors paddle_api_docs
$processors represents how many processes are started for compilation. Generally, it can be set to 1, 4, or 8.
After the compilation is complete, enter the doc/v2 directory. Three subdirectories are generated under this directory. You can enter the directories cn/html/, en/html, and api/en/html respectively and execute the following commands:
.. code-block:: bash
python -m SimpleHTTPServer 8088
Enter http://localhost:8088 in the browser to see the compiled Chinese/English documents page and the English APIs page. The following picture shows an example of a generated English document page.
.. image:: doc_en.png
:align: center
:scale: 60 %
How to write Documentations How to write Documentations
============ ============
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册