Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
csdn_franckjun
Paddle
提交
ee028bb5
P
Paddle
项目概览
csdn_franckjun
/
Paddle
与 Fork 源项目一致
Fork自
PaddlePaddle / Paddle
通知
1
Star
1
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
1
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
P
Paddle
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
1
Issue
1
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
ee028bb5
编写于
11月 02, 2016
作者:
Y
Yu Yang
提交者:
gangliao
11月 02, 2016
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Add How to build docs (#312)
上级
7180b424
变更
6
隐藏空白更改
内联
并排
Showing
6 changed file
with
89 addition
and
0 deletion
+89
-0
doc_cn/howto/how_to_write_docs/index.rst
doc_cn/howto/how_to_write_docs/index.rst
+63
-0
doc_cn/index.rst
doc_cn/index.rst
+1
-0
paddle/scripts/tools/build_docs/.gitignore
paddle/scripts/tools/build_docs/.gitignore
+2
-0
paddle/scripts/tools/build_docs/Dockerfile
paddle/scripts/tools/build_docs/Dockerfile
+6
-0
paddle/scripts/tools/build_docs/build.sh
paddle/scripts/tools/build_docs/build.sh
+13
-0
paddle/scripts/tools/build_docs/build_docs.sh
paddle/scripts/tools/build_docs/build_docs.sh
+4
-0
未找到文件。
doc_cn/howto/how_to_write_docs/index.rst
0 → 100644
浏览文件 @
ee028bb5
###############################
如何贡献/修改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/
\ No newline at end of file
doc_cn/index.rst
浏览文件 @
ee028bb5
...
...
@@ -15,6 +15,7 @@ PaddlePaddle文档
开发指南
--------
* `新写Layer <../doc/dev/new_layer/index.html>`_
* `如何贡献文档 <howto/how_to_write_docs/index.html>`_
算法教程
--------
...
...
paddle/scripts/tools/build_docs/.gitignore
0 → 100644
浏览文件 @
ee028bb5
doc
doc_cn
paddle/scripts/tools/build_docs/Dockerfile
0 → 100644
浏览文件 @
ee028bb5
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
paddle/scripts/tools/build_docs/build.sh
0 → 100755
浏览文件 @
ee028bb5
#!/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
paddle/scripts/tools/build_docs/build_docs.sh
0 → 100755
浏览文件 @
ee028bb5
#!/bin/bash
set
-e
docker build
.
-t
paddle_build_doc
docker run
--rm
-v
$PWD
/../../../../:/paddle
-v
$PWD
:/output paddle_build_doc
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录