Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs][hook] add a pre-commit hook to automatically insert space to cn and en char #4973

Merged
merged 32 commits into from
Aug 4, 2022
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
81bd6fd
replace tab with spaces
SigureMo Jul 27, 2022
992bbf1
CRLF -> LF
SigureMo Jul 27, 2022
7dbb805
trim trailing whitespace
SigureMo Jul 27, 2022
6159bdc
ensure-final-newline and trim-trailing-blank-lines
SigureMo Jul 27, 2022
231f8db
insert-whitespace-between-cn-and-en-char
SigureMo Jul 27, 2022
945102a
fix check_api_cn script to ignore some files not include sample code
SigureMo Jul 27, 2022
91955b1
use COPY-FROM to avoid some ci error
SigureMo Jul 27, 2022
e691bb4
make pre-commit also check rst
SigureMo Jul 27, 2022
2c08fd7
remove missing `.. code-block:: python`
SigureMo Jul 27, 2022
73e6dfa
Merge branch 'develop' into add-space-between-cn-en-char
SigureMo Jul 28, 2022
b3f848e
update api_white_list.txt
SigureMo Jul 28, 2022
ea3151b
Merge branch 'develop' into add-space-between-cn-en-char
SigureMo Jul 29, 2022
ac07624
fix the issue caused by upstream
SigureMo Jul 29, 2022
6521aa2
add a pre-commit hook to automatically insert space to cn and en char
SigureMo Aug 1, 2022
c3fc4d6
Merge branch 'develop' into add-space-between-cn-en-char
SigureMo Aug 1, 2022
9e2a0bb
Merge branch 'develop' into add-space-between-cn-en-char
SigureMo Aug 1, 2022
f48202f
fix style issues from upstream
SigureMo Aug 1, 2022
00f9ea6
bump pre-commit hooks version
SigureMo Aug 1, 2022
4712d79
Merge branch 'develop' into add-space-between-cn-en-char
SigureMo Aug 1, 2022
703bf1c
Merge branch 'develop' into add-space-between-cn-en-char
SigureMo Aug 2, 2022
af77994
more COPY-FROM (the file only include one code block)
SigureMo Aug 2, 2022
2cd0bfd
remove redundant labels
SigureMo Aug 2, 2022
7cb6aff
more COPY-FROM (try multiple code example)
SigureMo Aug 2, 2022
9fc8b90
Merge branch 'develop' into add-space-between-cn-en-char
SigureMo Aug 2, 2022
effb380
restore HDFSClient changes
SigureMo Aug 3, 2022
f942f8a
Merge branch 'develop' into add-space-between-cn-en-char
SigureMo Aug 3, 2022
155cc1d
fix style issues from upstream
SigureMo Aug 3, 2022
4f2d798
use COPY-FROM to avoid ci issue
SigureMo Aug 3, 2022
693fd83
Merge branch 'develop' into add-space-between-cn-en-char
SigureMo Aug 4, 2022
af6fe6e
Merge branch 'develop' into add-space-between-cn-en-char
SigureMo Aug 4, 2022
0725e4d
Merge branch 'develop' into add-space-between-cn-en-char
SigureMo Aug 4, 2022
d85c64e
Merge branch 'develop' into add-space-between-cn-en-char
SigureMo Aug 4, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
20 changes: 10 additions & 10 deletions CONTRIBUTING_cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,34 @@

- 使用教程
- 应用实践
- API文档
- API 文档

### 使用教程

这部分内容主要是对飞桨框架的使用指南的说明,你可以对现有的内容进行纠错或者是改进,也可以新增你认为重要的文档在这个栏目中。我们非常欢迎你提出任何关于使用教程文档的建议以及修改。

### 应用实践

应用实践主要是使用飞桨框架进行具体的案例实现。目前已经有许多开发者贡献了非常优秀的案例,如OCR识别、人脸关键点检测等,我们非常欢迎你提交你的项目到我们的repo中来,并最终呈现在飞桨的官网上。
应用实践主要是使用飞桨框架进行具体的案例实现。目前已经有许多开发者贡献了非常优秀的案例,如 OCR 识别、人脸关键点检测等,我们非常欢迎你提交你的项目到我们的 repo 中来,并最终呈现在飞桨的官网上。

### API文档
### API 文档

API文档是飞桨框架的API文档,包含了飞桨框架API的说明介绍。我们非常欢迎你对我们的API文档提出修改,不管是typo或者是修改说明与示例,我们都非常感谢你对于API文档所作出的任何贡献
API 文档是飞桨框架的 API 文档,包含了飞桨框架 API 的说明介绍。我们非常欢迎你对我们的 API 文档提出修改,不管是 typo 或者是修改说明与示例,我们都非常感谢你对于 API 文档所作出的任何贡献

## 参与方式

### 使用教程

这部分内容存放在 [docs/docs/guides](https://github.com/PaddlePaddle/docs/tree/develop/docs/guides) 目录下,你可以通过提交PR的方式,来作出你的修改。具体修改方式请参考:[文档贡献指南](https://github.com/PaddlePaddle/docs/wiki/%E6%96%87%E6%A1%A3%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)。
这部分内容存放在 [docs/docs/guides](https://github.com/PaddlePaddle/docs/tree/develop/docs/guides) 目录下,你可以通过提交 PR 的方式,来作出你的修改。具体修改方式请参考:[文档贡献指南](https://github.com/PaddlePaddle/docs/wiki/%E6%96%87%E6%A1%A3%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)。

### 应用实践

这部分内容分为源代码与官网文档两部分,源代码的部分以notebook的形式,存放在 [book/paddle2.0_docs](https://github.com/PaddlePaddle/book/tree/develop/paddle2.0_docs) 目录下,你可以提交你的notebook格式的源码于该目录中;在你的notebook文件被合入后,我们会将其转为md文件,存储在[docs/docs/tutorial](https://github.com/PaddlePaddle/docs/tree/develop/docs/tutorial)中,然后呈现到官网。具体信息请参考:[[Call for Contribution] Tutorials for PaddlePaddle 2.0](https://github.com/PaddlePaddle/book/issues/905).
这部分内容分为源代码与官网文档两部分,源代码的部分以 notebook 的形式,存放在 [book/paddle2.0_docs](https://github.com/PaddlePaddle/book/tree/develop/paddle2.0_docs) 目录下,你可以提交你的 notebook 格式的源码于该目录中;在你的 notebook 文件被合入后,我们会将其转为 md 文件,存储在[docs/docs/tutorial](https://github.com/PaddlePaddle/docs/tree/develop/docs/tutorial)中,然后呈现到官网。具体信息请参考:[[Call for Contribution] Tutorials for PaddlePaddle 2.0](https://github.com/PaddlePaddle/book/issues/905).

### API文档
### API 文档

飞桨框架同时提供中英文API文档。其中,英文API文档存于[Paddle](https://github.com/PaddlePaddle/Paddle/tree/develop/python/paddle)源代码中,绝大部分通过官网文档的源代码即可链接到,你可以在此位置对英文文档进行修改;而中文API文档存放在[docs/docs/api](https://github.com/PaddlePaddle/docs/tree/develop/docs/api)目录下。你可以针对文档中的任何错误与内容进行修复与完善,或者是新增你认为该文档中所需要的内容,我们非常感谢你对于API文档所付出的一切。具体修改方式请参考:[英文API文档贡献指南](https://github.com/PaddlePaddle/docs/wiki/%E8%8B%B1%E6%96%87API%E6%96%87%E6%A1%A3%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)、[中文API文档贡献指南](https://github.com/PaddlePaddle/docs/wiki/%E4%B8%AD%E6%96%87API%E6%96%87%E6%A1%A3%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)。
飞桨框架同时提供中英文 API 文档。其中,英文 API 文档存于[Paddle](https://github.com/PaddlePaddle/Paddle/tree/develop/python/paddle)源代码中,绝大部分通过官网文档的源代码即可链接到,你可以在此位置对英文文档进行修改;而中文 API 文档存放在[docs/docs/api](https://github.com/PaddlePaddle/docs/tree/develop/docs/api)目录下。你可以针对文档中的任何错误与内容进行修复与完善,或者是新增你认为该文档中所需要的内容,我们非常感谢你对于 API 文档所付出的一切。具体修改方式请参考:[英文 API 文档贡献指南](https://github.com/PaddlePaddle/docs/wiki/%E8%8B%B1%E6%96%87API%E6%96%87%E6%A1%A3%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)、[中文 API 文档贡献指南](https://github.com/PaddlePaddle/docs/wiki/%E4%B8%AD%E6%96%87API%E6%96%87%E6%A1%A3%E8%B4%A1%E7%8C%AE%E6%8C%87%E5%8D%97)。

## 提交PR
## 提交 PR

你对于飞桨文档的任何修改,都应该通过提交PR的方式来完成,具体的方法可以参考[提交PR](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/08_contribution/local_dev_guide.html)
你对于飞桨文档的任何修改,都应该通过提交 PR 的方式来完成,具体的方法可以参考[提交 PR](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/08_contribution/local_dev_guide.html)
4 changes: 2 additions & 2 deletions README_cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

docs 是 [PaddlePaddle 官网文档](https://www.paddlepaddle.org.cn/documentation/docs/zh/guides/index_cn.html) 的源文件。

注意:英文版API文档直接从[PaddlePaddle/Paddle](https://github.com/PaddlePaddle/Paddle) 的 docstring 中生成,[飞桨其他项目](https://www.paddlepaddle.org.cn/overview)的文档分别在其对应的位置中管理。
注意:英文版 API 文档直接从[PaddlePaddle/Paddle](https://github.com/PaddlePaddle/Paddle) 的 docstring 中生成,[飞桨其他项目](https://www.paddlepaddle.org.cn/overview)的文档分别在其对应的位置中管理。

## 仓库结构

- [docs](docs): 飞桨框架 2.0 以及之后版本文档的源文件。
- [docs/api](docs/api): 飞桨中文 API文档的源文件
- [docs/api](docs/api): 飞桨中文 API 文档的源文件
- [docs/guides](docs/guides): 飞桨官方教程的源文件。
- [docs/tutorial](docs/tutorial): 飞桨相关案例的源文件。
- [ci_scripts](ci_scripts): docs CI 相关的文件。
Expand Down
2 changes: 1 addition & 1 deletion ci_scripts/check_api_cn.sh
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ function filter_cn_api_files() {
local __resultvar=$2
local need_check_files=""
for file in `echo $git_files`;do
grep "code-block" ../docs/$file > /dev/null
grep 'code-block:: python' ../docs/$file > /dev/null
Copy link
Member Author

@SigureMo SigureMo Jul 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

原来 CI 中有部分示例代码因为 no sample code 问题而报错,这是因为在这里筛选是否 need check 的文件时仅仅 check 了是否包含 code-block,然而有些文件是包含一些非可运行的 code-block 的,比如 code-block:: text,这些文件之后传入 chinese_samplecode_processor.py 就会报 no sample code 错误

因此这里收缩检查条件,仅仅包含 code-block:: python 才进行后续 check

目前遇到该问题的文件有以下 8 个,这 8 个文件均不会通过 grep 'code-block:: python' $filename 的检查,也就不会传入后续 check

  • docs/api/paddle/add_n_cn.rst
  • docs/api/paddle/distributed/launch_cn.rst
  • docs/api/paddle/incubate/nn/functional/fused_multi_head_attention_cn.rst
  • docs/api/paddle/multiplex_cn.rst
  • docs/api/paddle/profiler/make_scheduler_cn.rst
  • docs/api/paddle/squeeze_cn.rst
  • docs/api/paddle/text/Overview_cn.rst
  • docs/api/paddle/uniform_cn.rst

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

修改后 CI 不再出现 no sample code 的问题

if [ $? -eq 0 ] ;then
api_file=`echo $file | sed 's#api/##g'`
grep -w "${api_file}" ${DIR_PATH}/api_white_list.txt > /dev/null
Expand Down
1 change: 0 additions & 1 deletion docs/advanced_guide/index_en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,3 @@ So far you have already been familiar with PaddlePaddle. And the next expectatio

inference_deployment/index_en.rst
flags/flags_en.rst

Loading