Docs: use linkcheck build to verify external links
未关闭
还没有人认领这个 Issue。
documentation
- 主要语言
- Python
- 星标
- 150
- 派生
- 23
- 平均合并
- 1 天 11 小时
- 30 天内合并 PR
- 2
描述
As part of our release process we manually test links e.g. to the relevant sections in the CF conventions. This check can be largely automated (all but fixing incorrect links) by running the sphinx.builders.linkcheck builder which detects broken links and raises warnings if they are found.
Addressing this will help towards automation of the release process (see #134).
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
未指定文件或测试。首先定位 Sphinx 文档构建配置和发布流程相关引用，然后查看 linkcheck builder 文档。完成的标准是：发布文档构建会检查外部链接，并将失效链接报告为警告，而无需手动测试链接。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation, release
- Issue 类型
- 功能
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100