Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
PaddlePaddle
Paddle
提交
bcdfe2cd
P
Paddle
项目概览
PaddlePaddle
/
Paddle
1 年多 前同步成功
通知
2302
Star
20931
Fork
5422
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
1423
列表
看板
标记
里程碑
合并请求
543
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
P
Paddle
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
1,423
Issue
1,423
列表
看板
标记
里程碑
合并请求
543
合并请求
543
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
bcdfe2cd
编写于
4月 24, 2017
作者:
Q
qijun
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
add docs
上级
78b322fd
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
29 addition
and
3 deletion
+29
-3
doc/howto/dev/write_docs_cn.rst
doc/howto/dev/write_docs_cn.rst
+29
-3
未找到文件。
doc/howto/dev/write_docs_cn.rst
浏览文件 @
bcdfe2cd
...
@@ -37,17 +37,43 @@ PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式。
...
@@ -37,17 +37,43 @@ PaddlePaddle的文档构建有直接构建和基于Docker构建两种方式。
直接构建PaddlePaddle的文档
直接构建PaddlePaddle的文档
--------------------------
--------------------------
TBD
因为PaddlePaddle的v2 api文档生成过程依赖于py_paddle Python包,用户需要首先确认py_paddle包已经安装。
.. code-block:: bash
python -c "import py_paddle"
如果提示错误,那么用户需要在本地编译安装PaddlePaddle,请参考 `源码编译文档 <http://www.paddlepaddle.org/develop/doc/getstarted/build_and_install/build_from_source_en.html>`_ 。
注意,用户需要安装编译在首次编译安装PaddlePaddle时,请将WITH_DOC选项关闭。在编译安装正确之后,确认py_paddle包已经安装,即可进行下一步操作。
如果提示正确,可以执行以下命令编译生成文档,即
.. code-block:: bash
cd TO_YOUR_PADDLE_CLONE_PATH
mkdir build_doc
cd build_doc
cmake .. -DWITH_DOC=ON
make paddle_docs paddle_docs_cn -j `nproc`
编译完成之后,在build_doc/doc目录之下会生成如下两个子目录\:
* en 英文文档目录
* cn 中文文档目录
打开浏览器访问对应目录下的index.html即可访问本地文档。
如何书写PaddlePaddle的文档
如何书写PaddlePaddle的文档
==========================
==========================
TBD
PaddlePaddle文档使用sphix自动生成,用户可以参考sphinx教程进行书写。
如何更新www.paddlepaddle.org文档
如何更新www.paddlepaddle.org文档
================================
================================
TBD
目前PaddlePaddle的develop分支的文档是自动触发更新的。用户可以在http://www.paddlepaddle.org/develop/doc_cn/与http://www.paddlepaddle.org/develop/doc/上分别查看最新的中英文文档。
.. _cmake: https://cmake.org/
.. _cmake: https://cmake.org/
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录