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清理] 清理未暴露在 sphinx toctree 下的文档 #6491

Closed
ooooo-create opened this issue Jan 26, 2024 · 4 comments
Closed

[docs清理] 清理未暴露在 sphinx toctree 下的文档 #6491

ooooo-create opened this issue Jan 26, 2024 · 4 comments
Assignees
Labels
HappyOpenSource 快乐开源活动issue与PR PFCC Paddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfcc

Comments

@ooooo-create
Copy link
Collaborator

ooooo-create commented Jan 26, 2024

背景

目前 docs 仓库中存在许多目录和文件是让我们感到困惑的,有些是和 docs 毫无关系的文件,有些是早就废弃的文件。在我们更新版本和规范的过程中,总会遇到这些神奇的文件,改也是,不改也不是。所以我们需要对现在的 docs 仓库进行一次文档清理。首先是清理一些在 Paddle 官网中找不到直接入口的文件。

docs 仓库的文档和网页url有着一一对应的关系,可以方便的预览文件

现状

docs 仓库文档大部分是使用 rst 格式编写,还有小部分 md 格式,以及 jupyter。使用 sphinx 作为构建文档的工具链。sphinx 在 Docutils (解析和处理 rst 文件) 的基础上增加了许多适用于智能生成和美化文档的指令,其中就包括 .. toctree:: 来处理文件之间的关系。

所有在 源目录 (或者其子目录)必须出现在 toctree 中;如果发现文件不在 toctree 中,Sphinx将会抛出警告,因为这意味着,通过标准的导航,这个文件将是不可到达的

我们需要对这些导航不可达的文件进行判断是否应该保留,并记录原因,借此了解此仓库的结构并可能发现更好的 docs 目录结构。

文档列表

序号 文件或目录 是否保留 原因
1 docs/install/install_script.md  @Wang-ZengWei #6616
 
2 docs/install/FAQ_en.md  @Wang-ZengWei #6616
 
3 docs/install/FAQ.md  @Wang-ZengWei #6616
 
4 docs/guides/advanced/visualdl_cn.md  @Wang-ZengWei #6617
 
5 docs/guides/advanced/visualdl_en.md  @Wang-ZengWei #6617
 
6 docs/guides/jit/basic_usage_en.md  @Wang-ZengWei #6624
 
7 docs/guides/06_distributed_training/cluster_quick_start_cn.rst  @Wang-ZengWei #6626
 
8 docs/guides/06_distributed_training/cluster_quick_start_fl_ps_cn.rst  @Wang-ZengWei #6626 #6641
 
9 docs/guides/06_distributed_training/fleet_api_howto_cn.rst  @Wang-ZengWei #6626
 
10 docs/guides/performance_improving/device_switching.md  @hu-qi #6613
 
11 docs/guides/performance_improving/memory_optimize.rst  @hu-qi #6613
 
12 docs/guides/performance_improving/memory_optimize_en.rst  @hu-qi #6613
 
13 docs/guides/performance_improving/paddle_tensorrt_infer.md  @hu-qi #6613
 
14 docs/guides/performance_improving/paddle_tensorrt_infer_en.md  @hu-qi #6613
 
15 docs/guides/performance_improving/quantization.md  @hu-qi #6613
 
16 docs/guides/performance_improving/analysis_tools/*  @hu-qi #6613
 
17 docs/guides/model_convert/load_old_format_model_cn.rst  @Wang-ZengWei #6630
 
18 docs/guides/model_convert/migration_cn.rst  @Wang-ZengWei #6630
 
19 docs/guides/model_convert/update_cn.md  @Wang-ZengWei #6630
 
20 docs/guides/model_convert/convert_from_pytorch/apply_reference_from_api_difference.py  @Wang-ZengWei
 
21 docs/guides/model_convert/convert_from_pytorch/validate_mapping_in_api_difference.py  @Wang-ZengWei
 
22 docs/guides/model_convert/convert_from_pytorch/api_difference/*  @Wang-ZengWei
 
23 docs/guides/flags/check_nan_inf_cn.md  @Wang-ZengWei
 
24 docs/guides/flags/check_nan_inf_en.md  @Wang-ZengWei
 
25 docs/guides/flags/flags_cn.rst  @Wang-ZengWei
 
26 docs/guides/flags/flags_en.rst  @Wang-ZengWei
 
27 docs/guides/cinn/*  @Wang-ZengWei #6630
 
28 docs/guides/10_contribution/*  @Wang-ZengWei #6630
 
29 docs/dev_guides/api_contributing_guides/new_cpp_op_en.md  @hu-qi #6613
 
30 docs/dev_guides/api_contributing_guides/new_cpp_op_notes_en.md  @hu-qi #6613
 
31 docs/dev_guides/custom_device_docs/ccl_api_cn.md  @hu-qi #6613
 
32 docs/dev_guides/custom_device_docs/custom_device_overview_cn.md  @hu-qi #6613
 
33 docs/dev_guides/custom_device_docs/device_api_cn.md  @ooooo-create
 
34 docs/dev_guides/custom_device_docs/device_api_en.md  @ooooo-create
 
35 docs/dev_guides/custom_device_docs/event_api_cn.md  @ooooo-create
 
36 docs/dev_guides/custom_device_docs/event_api_en.md  @ooooo-create
 
37 docs/dev_guides/custom_device_docs/memory_api_cn.md  @ooooo-create
 
38 docs/dev_guides/custom_device_docs/memory_api_en.md  @ooooo-create
 
39 docs/dev_guides/custom_device_docs/new_device_backend_overview_cn.md  @ooooo-create
 
40 docs/dev_guides/custom_device_docs/profiler_api_cn.md  @ooooo-create
 
41 docs/dev_guides/custom_device_docs/runtime_data_type_cn.md  @ooooo-create
 
42 docs/dev_guides/custom_device_docs/runtime_data_type_en.md  @ooooo-create
 
43 docs/dev_guides/custom_device_docs/stream_api_cn.md  @ooooo-create
 
44 docs/dev_guides/custom_device_docs/stream_api_en.md  @ooooo-create
 
45 docs/dev_guides/custom_device_docs/custom_kernel_docs/*  @ooooo-create
 
46 docs/dev_guides/git_guides/*  @ooooo-create #6618
 
47 docs/dev_guides/op_optimization/kernel_primitive_api/add_example_en.md  @hu-qi #6632
 
48 docs/dev_guides/op_optimization/kernel_primitive_api/api_description_en.rst  @hu-qi #6632
 
49 docs/dev_guides/op_optimization/kernel_primitive_api/compute_api_en.md  @hu-qi #6632
 
50 docs/dev_guides/op_optimization/kernel_primitive_api/example_en.rst  @hu-qi #6632
 
51 docs/dev_guides/op_optimization/kernel_primitive_api/functor_api_en.md  @hu-qi #6632
 
52 docs/dev_guides/op_optimization/kernel_primitive_api/index_en.rst  @hu-qi #6632
 
53 docs/dev_guides/op_optimization/kernel_primitive_api/io_api_en.md  @hu-qi #6632
 
54 docs/dev_guides/op_optimization/kernel_primitive_api/model_example_en.md  @hu-qi #6632
 
55 docs/dev_guides/op_optimization/kernel_primitive_api/reduce_example_en.md  @hu-qi #6632
 
56 docs/eval/*  @hu-qi #6613
 
57 docs/advanced_guide/*  @hu-qi #6613
 
58 docs/design/*  @hu-qi #6613
 

任务认领

Note

1. Issue 回复格式
为了自动填写报名信息,需要在 issue 下回复报名信息,如果报名格式不正确,则会在 comment 区提示报名不正确,格式如下:

【报名】: 2、3、6-10

其中【报名】: 后直接是报名的赛题序号,多个赛题之间需要用中文顿号分隔,多个连续赛题可以用横线表示

Note

2. PR 标题格式

[Docathon][Remove File No.2、3、6-10]

PR的标题中以 [Docathon][Remove File No.xxxx] 开头即可,程序会自动提取赛题编号并更新榜单。
一个 PR 也可以提交多个赛题,多个赛题间以顿号横线分隔,比如 No.24、26-28、30 赛题。

Note

3.comment 方式
先通过 1 的方式进行报名,然后对于自己报名的文档,重新评论一次,然后在此新的评论上维护所有报名文档的信息
格式如下

序号 文件或目录 是否保留 原因
xxx xxx 不保留 xxx

看板信息

任务方向 任务数量 提交作品 / 任务认领 提交率 完成 完成率
Docathon 58 38 / 58 65.52% 36 62.07%

统计信息

排名不分先后 @Wang-ZengWei (13) @hu-qi (23)

@paddle-bot paddle-bot bot added the PFCC Paddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfcc label Jan 26, 2024
@luotao1 luotao1 added the HappyOpenSource 快乐开源活动issue与PR label Apr 9, 2024
@hu-qi
Copy link
Contributor

hu-qi commented Apr 10, 2024

【报名】: 10-16、29-32、56-58

@Wang-ZengWei
Copy link
Contributor

【报名】: 1-9、17-28

@ooooo-create
Copy link
Collaborator Author

ooooo-create commented Apr 17, 2024

【报名】: 33-46

@hu-qi
Copy link
Contributor

hu-qi commented Apr 30, 2024

【报名】: 47-55

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
HappyOpenSource 快乐开源活动issue与PR PFCC Paddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfcc
Projects
Development

No branches or pull requests

4 participants