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 (925 forks)batch import
documentationgood first issueneeds contributor

Repository metrics

Stars
 (9,293 stars)
PR merge metrics
 (平均マージ 2d 7h) (30d で 9 merged PRs)

説明

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

コントリビューターガイド

調査方針
Sphinx文書で、'nitpicky'オプションと壊れたリンクの警告を有効にする方法を確認してください。
技術スタック
python
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1時間未満
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
なし
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90