如何贡献/修改文档

PaddlePaddle的文档包括英文文档 doc 和中文文档 doc_cn 两个部分。文档都是通过 cmake 驱动 sphinx 编译生成,生成后的文档分别存储在编译目录的 docdoc_cn 两个子目录下。

如何构建PaddlePaddle的文档

PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式,我们提供了一个构建脚本build_docs.sh来进行构建。 PaddlePaddle文档需要准备的环境相对较复杂,所以我们推荐使用基于Docker来构建PaddlePaddle的文档。

使用Docker构建PaddlePaddle的文档

使用Docker构建PaddlePaddle的文档,需要在系统里先安装好Docker工具包。Docker安装请参考 Docker的官网 。安装好Docker之后可以使用源码目录下的脚本构建文档,即

cd TO_YOUR_PADDLE_CLONE_PATH
cd paddle/scripts/tools/build_docs
bash build_docs.sh with_docker

编译完成后,会在当前目录生成两个子目录:

  • doc 英文文档目录
  • doc_cn 中文文档目录

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

直接构建PaddlePaddle的文档

因为PaddlePaddle的v2 api文档生成过程依赖于py_paddle Python包,用户需要首先确认py_paddle包已经安装。

python -c "import py_paddle"

如果提示错误,那么用户需要在本地编译安装PaddlePaddle,请参考 源码编译文档 。 注意,用户在首次编译安装PaddlePaddle时,请将WITH_DOC选项关闭。在编译安装正确之后,请再次确认py_paddle包已经安装,即可进行下一步操作。

如果提示正确,可以执行以下命令编译生成文档,即

cd TO_YOUR_PADDLE_CLONE_PATH
cd paddle/scripts/tools/build_docs
bash build_docs.sh local

编译完成之后,会在当前目录生成两个子目录:

  • doc 英文文档目录
  • doc_cn 中文文档目录

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

如何书写PaddlePaddle的文档

PaddlePaddle文档使用 sphinx 自动生成,用户可以参考sphinx教程进行书写。

如何更新www.paddlepaddle.org文档

开发者给PaddlePaddle代码增加的注释以PR的形式提交到github中,提交方式可参见 贡献文档 。 目前PaddlePaddle的develop分支的文档是自动触发更新的,用户可以分别查看最新的 中文文档英文文档