前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >如何贡献文档

如何贡献文档

作者头像
用户1386409
发布2018-03-15 14:33:31
1K0
发布2018-03-15 14:33:31
举报
文章被收录于专栏: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分支的文档是自动触发更新的,用户可以分别查看最新的 中文文档 和 英文文档 。(点击“阅读原文”查看)

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2018-02-27,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 PaddlePaddle 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
相关产品与服务
容器镜像服务
容器镜像服务(Tencent Container Registry,TCR)为您提供安全独享、高性能的容器镜像托管分发服务。您可同时在全球多个地域创建独享实例,以实现容器镜像的就近拉取,降低拉取时间,节约带宽成本。TCR 提供细颗粒度的权限管理及访问控制,保障您的数据安全。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档