falconry/falcon

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

Open

#1,888 opened on 2021年3月16日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)Python (9,293 stars) (925 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.