Skip to content

Commit d3126ad

Browse files
committed
"fix based comments"
1 parent b08fd0a commit d3126ad

File tree

1 file changed

+4
-9
lines changed

1 file changed

+4
-9
lines changed

doc/v2/dev/index_cn.rst

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,24 @@
11
开发标准
22
========
3-
PaddlePaddle遵守如下三个部分的代码和文档规范
3+
PaddlePaddle遵守如下三个部分的代码和文档规范
44

5-
- 代码风格
6-
PaddlePaddle中包含了Cuda, C++, Python, Shell等多种编程语言。语言规范遵守Google C++ Style, Pep-8, 代码库中包含自动化检查工具做风格检查。不满足风格要求的代码会编译失败。pre-commit也会自动format, 协助修改代码格式。
5+
PaddlePaddle使用git做版本管理,docker作为构建和测试环境。代码中包含了Cuda, C++, Python, Shell等多种编程语言。语言规范遵守Google C++ Style, Pep-8, 代码库中包含自动化检查工具做风格检查。代码注释需要遵守Doxygen规范,不满足风格要求的代码会编译失败。关于如何使用git, 构建测试及代码开发, 我们提供了如下指南。
76

87
.. toctree::
98
:maxdepth: 1
109

1110
contribute_to_paddle_cn.md
1211

13-
- 文档格式
14-
PaddlePaddle面向国内外用户,包含了中文和英文两部分的文档。设计文档和issue问题描述都推荐使用英文。对于设计文档,重在问题描述,背景阐述,然后才是解决方案。API文档由Sphinx生成,因此代码注释需要符合Sphinx文档标准。同样的,PaddlePaddle的集成测试工具会检测文档格式。推荐本地使用docker编译生成文档,本地修复文档。
12+
PaddlePaddle面向国内外用户,包含了中文和英文两部分的文档。设计文档和issue问题描述都推荐使用英文。对于设计文档,重在问题描述,背景阐述,然后才是解决方案。文档由Sphinx生成,因此代码注释也需要符合Sphinx文档标准。推荐本地使用paddlepaddle.org工具编译生成和预览文档,请参阅如下文档。
1513

1614
.. toctree::
1715
:maxdepth: 1
1816

1917
write_docs_cn.rst
2018

21-
- 框架定制
22-
PaddlePaddle V2使用新增Layer方式定义新的操作。组合基础api可以实现多种复杂Layer, 满足绝大多数应用。如需要定制Layer,请参阅如下文档,欢迎提交patch.
19+
PaddlePaddle V2 使用新增Layer方式定义新的操作。组合基础API可以实现多种复杂Layer, 满足绝大多数应用。如需要定制Layer,请参阅如下文档,欢迎提交patch。
2320

2421
.. toctree::
2522
:maxdepth: 1
2623

2724
new_layer_cn.rst
28-
29-
此外,PaddlePaddle推荐使用docker作为开发环境。对于GPU环境,使用nvidia-docker,统一开发和集成环境。

0 commit comments

Comments
 (0)