Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
PaddlePaddle
FluidDoc
提交
02c6eb7d
F
FluidDoc
项目概览
PaddlePaddle
/
FluidDoc
通知
5
Star
2
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
23
列表
看板
标记
里程碑
合并请求
111
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
F
FluidDoc
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
23
Issue
23
列表
看板
标记
里程碑
合并请求
111
合并请求
111
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
02c6eb7d
编写于
10月 18, 2018
作者:
T
Tink_Y
提交者:
GitHub
10月 18, 2018
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Update write_docs_cn.md
上级
c35b7a65
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
64 addition
and
28 deletion
+64
-28
doc/v2/dev/write_docs_cn.md
doc/v2/dev/write_docs_cn.md
+64
-28
未找到文件。
doc/v2/dev/write_docs_cn.md
浏览文件 @
02c6eb7d
...
@@ -83,16 +83,13 @@ pip install -r requirements.txt
...
@@ -83,16 +83,13 @@ pip install -r requirements.txt
--models <path_to_fluiddoc_dir>/external/models \
--models <path_to_fluiddoc_dir>/external/models \
--mobile <path_to_fluiddoc_dir>/external/mobile
--mobile <path_to_fluiddoc_dir>/external/mobile
```
```
然后:
然后:打开浏览器并导航到http://localhost:8000。
打开浏览器并导航到http://localhost:8000。
>*网站可能需要几秒钟才能成功加载,因为构建需要一定的时间*
>*网站可能需要几秒钟才能成功加载,因为构建需要一定的时间*
>*如果您是在docker环境下运行的这些步骤,请检查ip确保可以将端口8000映射到您的主机*
>*如果您是在docker环境下运行的这些步骤,请检查ip确保可以将端口8000映射到您的主机*
##
预览
新文档或更新API
##
贡献
新文档或更新API
所有内容都应该以
[
Markdown
](
https://guides.github.com/features/mastering-markdown/
)
(
GitHub风格
)
的形式编写(尽管在文档中有一些使用.rst格式的遗留内容)。
所有内容都应该以
[
Markdown
](
https://guides.github.com/features/mastering-markdown/
)
(
GitHub风格
)
的形式编写(尽管在文档中有一些使用.rst格式的遗留内容)。
...
@@ -101,63 +98,102 @@ pip install -r requirements.txt
...
@@ -101,63 +98,102 @@ pip install -r requirements.txt
-
在你开始写作之前,我们建议你回顾一下这些关于贡献内容的指南
-
在你开始写作之前,我们建议你回顾一下这些关于贡献内容的指南
---
**贡献新文档**
**贡献新文档**
---
-
创建一个新的
` .md`
文件或者在您当前操作的仓库中修改已存在的文章
-
创建一个新的
` .md`
文件或者在您当前操作的仓库中修改已存在的文章
-
将新增的文档名,添加到对应的index文件中
-
将新增的文档名,添加到对应的index文件中
---
**贡献或修改Python API**
**贡献或修改Python API**
---
在
将要重新编译代码的docker容器内
或主机的对应位置:
在
编译代码的docker容器内,
或主机的对应位置:
-
运行脚本
`paddle/scripts/paddle_build.sh`
(在 Paddle repo 下)
-
运行脚本
`paddle/scripts/paddle_build.sh`
(在 Paddle repo 下)
-
**或者**
(如果您想理解这一过程):
-
在
`Paddle`
仓库下创建一个新的文件夹用来编译文档,可以命名为
`build`
```
bash
-
在这个新文件夹下,运行下列
`cmake`
和
`make`
命令去构建新的PaddlePaddle:
# 编译paddle的python库
cd
Paddle
./paddle/scripts/paddle_docker_build.sh gen_doc_lib full
cd
..
```
-
运行预览工具
```
# 在编译paddle的对应docker镜像中运行预览工具
docker run -it -v /Users/xxxx/workspace/paddlepaddle_workplace:/workplace -p 8000:8000 [images_id] /bin/bash
```
> 其中`/Users/xxxx/workspace/paddlepaddle_workplace`请替换成您本机的paddle工作环境,`/workplace`请替换成您相应的 docker 下的工作环境,这一映射会保证我们同时完成编译python库、修改FluidDoc和使用预览工具。
> [images_id]为docker中您使用的paddlepaddle的镜像id。
-
设置环境变量
```
# 在docker环境中
# 设置环境变量`PYTHONPATH`使预览工具可以找到 paddle 的 python 库
export PYTHONPATH=/workplace/Paddle/build/python/
```
```
cmake .. -DCMAKE_BUILD_TYPE=Release -DWITH_DOC=ON -DWITH_GPU=OFF -DWITH_MKL=OFF -DWITH_FLUID_ONLY=ON
# You may replace `nproc` with the number of processor cores your system can offer for the build.
-
清理旧文件
make -j `nproc` gen_proto_py framework_py_proto copy_paddle_pybind paddle_python
```
# 清除历史生成的文件,如果是第一次使用预览工具可以跳过这一步
rm -rf /workplace/FluidDoc/doc/fluid/menu.json /workplace/FluidDoc/doc/fluid/api/menu.json /tmp/docs/ /tmp/api/
```
```
-
设置环境变量
`PYTHONPATH`
去包含这个
`build`
(或任意其他您设置的名字)目录
-
启动预览工具
```
cd /workplace/PaddlePaddle.org/portal
pip install -r requirements.txt
./runserver --paddle /workplace/FluidDoc/
```
需要注意的是:如果您使用的是 Docker,
`paddle_docker_build.sh`
会构建一个新的 Docker 容器。这将破坏当前 Docker 下的 PaddlePaddle.org 安装,因此如果您想预览文档,不推荐您用这种方式编译代码。
---
**预览修改**
**预览修改**
---
打开浏览器并导航到http://localhost:8000。
在要更新的页面上,单击右上角的Refresh Content
在要更新的页面上,单击右上角的Refresh Content
进入使用文档单元后,API部分并不包含内容,希望预览API文档需要点击API目录,几分钟后您将看到生成的 API reference。
## 提交修改
## 提交修改
如果您希望修改代码,请在
`Paddle`
仓库下
执行下列步骤
。
如果您希望修改代码,请在
`Paddle`
仓库下
参考
[
如何贡献代码
](
)执行操作
。
如果您仅修改文档:
如果您仅修改文档:
-
若
修改的内容在
`doc`
文件夹内,您只需要在
`FluidDoc`
仓库下提交
`PR`
-
修改的内容在
`doc`
文件夹内,您只需要在
`FluidDoc`
仓库下提交
`PR`
-
若您
修改的内容在
`external`
文件夹内:
-
修改的内容在
`external`
文件夹内:
1.
在您修改的仓库下提交PR
,
`FluidDoc`
仓库只是一个包装器,将其他仓库的链接(git术语的“submodule”)集合在了一起。
1.
在您修改的仓库下提交PR
。这是因为:
`FluidDoc`
仓库只是一个包装器,将其他仓库的链接(git术语的“submodule”)集合在了一起。
2.
当您的修改被认可后,更新FluidDoc中对应的
`submodule`
到源仓库最新的commit-id。
2.
当您的修改被认可后,更新FluidDoc中对应的
`submodule`
到源仓库最新的commit-id。
> 例如,您更新了book仓库中的文档:
> 例如,您更新了book仓库中的develop分支下的文档:
> - 进入`book`目录
> - 进入`
FluidDoc/external/
book`目录
> -
切换到你想更新到的commit-id
> -
更新 commit-id 到最新的提交:`git pull origin develop`
> - 在`FluidDoc`中提交你的修改
> - 在`FluidDoc`中提交你的修改
3.
在
`FluidDoc`
仓库下为您的修改提交PR
3.
在
`FluidDoc`
仓库下为您的修改提交PR
提交PR的步骤可以参考
[
如何贡献代码
](
../development/contribute_to_paddle.html
)
提交
修改与
PR的步骤可以参考
[
如何贡献代码
](
../development/contribute_to_paddle.html
)
## 帮助改进预览工具
## 帮助改进预览工具
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录