falconry/falcon

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

開放

#1,888 建立於 2021年3月16日

在 GitHub 查看貢獻者指南
 (3 則留言) (0 個反應) (0 位負責人)Python (925 個分叉)batch import
documentationgood first issueneeds contributor

倉庫指標

星標
 (9,293 顆星)
PR 合併指標
 (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