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 (9,293 star) (925 fork)batch import
documentationgood first issueneeds contributor

描述

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

貢獻者指南

技術棧
python
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
PythonSphinx basics
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
The issue seeks to enable Sphinx warnings for broken links. The body already suggests setting nitpicky = True in conf.py or passing n. The implementation involves editing the Sphinx configuration file. No linked PRs or comments contradict this.