专栏首页PaddlePaddle如何贡献文档

如何贡献文档

如何贡献文档

PaddlePaddle的文档包括英文文档 doc 和中文文档 doc_cn 两个部分。文档都是通过 cmake 驱动 sphinx 编译生成,生成后的文档分别存储在编译目录的 doc 和 doc_cn 两个子目录下。 也可以利用PaddlePaddle 工具来编译文档,这个情况下所有的文件会存在整理过的的文件目录 .ppo_workspace/content 下。

1

如何构建文档

PaddlePaddle的文档构建有三种方式。

A.使用PaddlePaddle.org工具

这个是目前推荐的使用方法。除了可以自动编译文档,也可以直接在网页预览文档。文件工具是使用Docker,需要在系统里先安装好Docker工具包。Docker安装请参考Docker的官网。安装好Docker之后及可用以下命令启动工具

mkdir paddlepaddle # Create paddlepaddle working directory

cd paddlepaddle

# Clone the content repositories

git clone https://github.com/PaddlePaddle/Paddle.git

git clone https://github.com/PaddlePaddle/book.git

git clone https://github.com/PaddlePaddle/models.git

git clone https://github.com/PaddlePaddle/Mobile.git

# Please specify the working directory through -v

docker run -it -p 8000:8000 -v `pwd`:/var/content paddlepaddle/paddlepaddle.org:latest

注意: PaddlePaddle.org 会在 -v (volume) 指定的内容存储库运行命令 之后再用网页连到http://localhost:8000就可以在网页上生成需要的文档 编译后的文件将被存储在工作目录 <paddlepaddle working directory>/.ppo_workspace/content。

如果不想使用 Docker,你还可以通过运行Django框架直接激活工具的服务器。使用下面的命令来运行它。

mkdir paddlepaddle # Create paddlepaddle working directory

cd paddlepaddle

# Clone the content repositories and PaddlePaddle.org

git clone https://github.com/PaddlePaddle/Paddle.git

git clone https://github.com/PaddlePaddle/book.git

git clone https://github.com/PaddlePaddle/models.git

git clone https://github.com/PaddlePaddle/Mobile.git

git clone https://github.com/PaddlePaddle/PaddlePaddle.org.git

# Please specify the PaddlePaddle working directory. In the current setting, it should be pwd

export CONTENT_DIR=<path_to_paddlepaddle_working_directory>

export ENV=''

cd PaddlePaddle.org/portal/

pip install -r requirements.txt

python manage.py runserver

工具服务器将读取环境变量 CONTENT_DIR 搜索代码库。请指定的PaddlePaddle工作目录给环境变量 CONTENT_DIR。 之后再用网页连到http://localhost:8000就可以在网页上生成需要的文档。 编译后的文件将被存储在工作目录 <paddlepaddle working directory>/.ppo_workspace/content。

想了解更多PaddlePaddle.org工具的详细信息,可以访问(https://github.com/PaddlePaddle/PaddlePaddle.org/blob/develop/README.cn.md)。

B.使用Docker构建

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

cd TO_YOUR_PADDLE_CLONE_PATH

cd paddle/scripts/tools/build_docs

sh build_docs.sh

编译完成之后,会在当前目录生成两个子目录: doc(英文文档目录)和 doc_cn(中文文档目录)。 打开浏览器访问对应目录下的index.html即可访问本地文档。

C.直接构建

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

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(中文文档目录)。 打开浏览器访问对应目录下的index.html即可访问本地文档。

2

如何书写文档

PaddlePaddle文档使用 sphinx(http://www.sphinx-doc.org/en/1.4.8/) 自动生成,用户可以参考sphinx教程进行书写。

3

如何更新www.paddlepaddle.org

更新的文档以PR的形式提交到github中,提交方式参见 贡献文档 (http://www.paddlepaddle.org/docs/develop/documentation/en/howto/dev/contribute_to_paddle_en.html)。 目前PaddlePaddle的develop分支的文档是自动触发更新的,用户可以分别查看最新的 中文文档 和 英文文档 。(点击“阅读原文”查看)

本文分享自微信公众号 - PaddlePaddle(PaddleOpenSource),作者:PaddlePaddle

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2018-02-27

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 【使用指南】用Docker安装运行paddlepaddle

    编写|paddle 排版|wangp 使用Docker安装和运行PaddlePaddle可以无需考虑依赖环境即可运行。并且也可以在Windows的docker中...

    用户1386409
  • 转载|使用PaddleFluid和TensorFlow训练RNN语言模型

    在图像领域,最流行的 building block 大多以卷积网络为主。上一篇我们介绍了转载|使用PaddleFluid和TensorFlow实现图像分类网络S...

    用户1386409
  • 用飞桨检测谣言,新技能get!

    https://aistudio.baidu.com/aistudio/projectdetail/263255

    用户1386409
  • 在SAP CRM WebClient UI中用javascript触发ABAP event

    需求:在WebClient UI里不通过用户手动点击,而是使用JavaScript代码自动触发ABAP后台的代码。

    Jerry Wang
  • docker基础

    重点:volumes:将主机的数据卷或者文件挂载到容器里。(使得容器内目录与主机内目录完全同步)

    用户3258338
  • 一线UI设计师对APP切图尺寸换算指导

    工作后,很多同学还是会问到app切图尺寸的问题。今天分享android和iOS的换算分析,希望能帮到工作中的你。 1.在Android的显示模式为mdpi的时...

    用户1730674
  • Python每日一题:标准库

    1. 在 Python 中我们经常听到 模块、包、库、标准库、第三方库 这些概念,首先要对这些概念进行区分

    用户7685359
  • 为你的WordPress 博客文章页面增加多彩排版条

    不知这个上面这个题目会不会让人产生误解,再说明一下,所谓排版条即是如下面的一个绿色的彩条(当然颜色可以自己设定)。有了这个排版条,能更加容易区分内容文字及总结文...

    Jeff
  • QR 二维码布局(五)

    上一篇构建最终编码流程中,我们获取到最终包含数据码、纠错码和剩余字符的最终编码数据。接下来就是要最终的数据编码和其它必需的功能模块统一分配到 QR 二维码矩阵中...

    TTTEED
  • QML用Qt.labs.settings实现保存用户设置

    饶文津

扫码关注云+社区

领取腾讯云代金券