falconry/falcon

Doc: Explore Sphinx options if there is a flag to emit a warning on broken links

Open

#1,888 创建于 2021年3月16日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)Python (925 fork)batch import
documentationgood first issueneeds contributor

仓库指标

Star
 (9,293 star)
PR 合并指标
 (平均合并 2天 7小时) (30 天内合并 9 个 PR)

描述

Setting nitpicky = True in conf.py or passing the -n command line argument will warn on broken links.

贡献者指南

研究方向
查看 Sphinx 文档，了解 'nitpicky' 选项以及如何启用损坏链接的警告。
技术栈
python
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1 小时以内
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90