Skip to content

Commit

Permalink
Add How to build docs (#312)
Browse files Browse the repository at this point in the history
  • Loading branch information
reyoung authored and gangliao committed Nov 2, 2016
1 parent 7180b42 commit ee028bb
Show file tree
Hide file tree
Showing 6 changed files with 89 additions and 0 deletions.
63 changes: 63 additions & 0 deletions doc_cn/howto/how_to_write_docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
###############################
如何贡献/修改PaddlePaddle的文档
###############################

PaddlePaddle的文档使用 `cmake`_ 驱动 `sphinx`_ 生成。公有两个文档,:code:`doc` 和 :code:`doc_cn` 。这两者会在 `cmake`_ 中进行编译,生成后的文档会存储在服务器的 :code:`doc` 和 :code:`doc_cn` 两个目录下。

下面分几个部分介绍一下PaddlePaddle文档的贡献方法。

如何书写PaddlePaddle的文档
==========================

TBD

如何构建PaddlePaddle的文档
==========================

构建PaddlePaddle文档,需要使用构建Paddle的全部环境。准备这个环境相对来说比较复杂,所以本文档提供两种方式构建PaddlePaddle的文档,即

* 使用Docker构建PaddlePaddle的文档
* 直接构建PaddlePaddle的文档。

并且,我们推荐使用Docker来构建PaddlePaddle的文档。


使用Docker构建PaddlePaddle的文档
--------------------------------

使用Docker构建PaddlePaddle的文档,首先要求在系统里安装好Docker工具包。安装Docker请参考 `Docker的官网 <https://docs.docker.com/>`_ 。

安装好Docker之后可以使用源码目录下的脚本构建文档,即

.. code-block:: bash
cd TO_YOUR_PADDLE_CLONE_PATH
cd paddle/scripts/tools/build_docs
bash build_docs.sh
执行完这个脚本后,该目录下会生成两个目录,分别是\:

* doc 目录,英文文档地址
* doc_cn 目录,中文文档地址

打开浏览器访问对应目录下的index.html即可访问本地文档。

.. code-block:: bash
open doc_cn/index.html
直接构建PaddlePaddle的文档
--------------------------

TBD


如何更新www.paddlepaddle.org文档
================================

TBD


.. _cmake: https://cmake.org/
.. _sphinx: http://www.sphinx-doc.org/en/1.4.8/
1 change: 1 addition & 0 deletions doc_cn/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ PaddlePaddle文档
开发指南
--------
* `新写Layer <../doc/dev/new_layer/index.html>`_
* `如何贡献文档 <howto/how_to_write_docs/index.html>`_

算法教程
--------
Expand Down
2 changes: 2 additions & 0 deletions paddle/scripts/tools/build_docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
doc
doc_cn
6 changes: 6 additions & 0 deletions paddle/scripts/tools/build_docs/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
FROM paddledev/paddle:cpu-devel-latest
COPY build.sh /
RUN pip install sphinx &&\
apt install -y doxygen graphviz &&\
pip install breathe recommonmark numpy protobuf==2.6.1
CMD /build.sh
13 changes: 13 additions & 0 deletions paddle/scripts/tools/build_docs/build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#!/bin/bash
set -ex

mkdir -p /build
cd /build
cmake /paddle -DWITH_DOC=ON
make paddle_docs paddle_docs_cn -j `nproc`
mkdir -p /output/doc
mkdir -p /output/doc_cn
cp -r doc/html/* /output/doc/
cp -r doc_cn/html/* /output/doc_cn/
cd /
rm -rf /paddle/build
4 changes: 4 additions & 0 deletions paddle/scripts/tools/build_docs/build_docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/bash
set -e
docker build . -t paddle_build_doc
docker run --rm -v $PWD/../../../../:/paddle -v $PWD:/output paddle_build_doc

0 comments on commit ee028bb

Please sign in to comment.