[docs清理] 清理未暴露在 sphinx toctree 下的文档 #6491
Labels
HappyOpenSource
快乐开源活动issue与PR
PFCC
Paddle Framework Contributor Club,https://github.com/PaddlePaddle/community/tree/master/pfcc
背景
目前 docs 仓库中存在许多目录和文件是让我们感到困惑的,有些是和 docs 毫无关系的文件,有些是早就废弃的文件。在我们更新版本和规范的过程中,总会遇到这些神奇的文件,改也是,不改也不是。所以我们需要对现在的 docs 仓库进行一次文档清理。首先是清理一些在 Paddle 官网中找不到直接入口的文件。
现状
docs 仓库文档大部分是使用 rst 格式编写,还有小部分 md 格式,以及 jupyter。使用 sphinx 作为构建文档的工具链。sphinx 在 Docutils (解析和处理 rst 文件) 的基础上增加了许多适用于智能生成和美化文档的指令,其中就包括
.. toctree::
来处理文件之间的关系。我们需要对这些导航不可达的文件进行判断是否应该保留,并记录原因,借此了解此仓库的结构并可能发现更好的 docs 目录结构。
文档列表
docs/guides/model_convert/convert_from_pytorch/apply_reference_from_api_difference.pydocs/guides/model_convert/convert_from_pytorch/validate_mapping_in_api_difference.pydocs/guides/model_convert/convert_from_pytorch/api_difference/*docs/guides/flags/check_nan_inf_cn.mddocs/guides/flags/check_nan_inf_en.mddocs/guides/flags/flags_cn.rstdocs/guides/flags/flags_en.rstdocs/dev_guides/custom_device_docs/device_api_cn.mddocs/dev_guides/custom_device_docs/device_api_en.mddocs/dev_guides/custom_device_docs/event_api_cn.mddocs/dev_guides/custom_device_docs/event_api_en.mddocs/dev_guides/custom_device_docs/memory_api_cn.mddocs/dev_guides/custom_device_docs/memory_api_en.mddocs/dev_guides/custom_device_docs/new_device_backend_overview_cn.mddocs/dev_guides/custom_device_docs/profiler_api_cn.mddocs/dev_guides/custom_device_docs/runtime_data_type_cn.mddocs/dev_guides/custom_device_docs/runtime_data_type_en.mddocs/dev_guides/custom_device_docs/stream_api_cn.mddocs/dev_guides/custom_device_docs/stream_api_en.mddocs/dev_guides/custom_device_docs/custom_kernel_docs/*任务认领
Note
1. Issue 回复格式:
为了自动填写报名信息,需要在 issue 下回复报名信息,如果报名格式不正确,则会在 comment 区提示报名不正确,格式如下:
Note
2. PR 标题格式:
PR的标题中以
[Docathon][Remove File No.xxxx]
开头即可,程序会自动提取赛题编号并更新榜单。一个 PR 也可以提交多个赛题,多个赛题间以
顿号
或横线
分隔,比如 No.24、26-28、30 赛题。Note
3.comment 方式
先通过 1 的方式进行报名,然后对于自己报名的文档,重新评论一次,然后在此新的评论上维护所有报名文档的信息
格式如下
看板信息
统计信息
The text was updated successfully, but these errors were encountered: