sphinx-doc/sphinx

Provide a better error message if the master document is not included in project documents

クローズ

#11,873 opened on 2024/01/12

GitHub で見るコントリビューターガイド
 (3 件のコメント) (4 件のリアクション) (0 人の担当者)Python (1,985 件のフォーク)batch import
good first issuehelp wanted

Repository metrics

Stars
 (5,625 個のスター)
PR merge metrics
 (平均マージ 10d 11h) (30d で 11 merged PRs)

説明

If index.rst does not appear in the pattern of a custom {include,exclude}_patterns, the error message is less than helpful. Instead, we should check that the master doc appears in the Project documents, and provide a better error if it doesn’t.

Inspiration from https://github.com/sphinx-doc/sphinx/issues/11722#issuecomment-1886157588

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

調査方針
この問題は、マスタードキュメント（index.rst）がパターン適用後にプロジェクトドキュメントに含まれているかどうかを確認するものです。関連するコードは、ドキュメント発見が行われる sphinx/project/ init .py にある可能性があります。目標は、ドキュメント発見後に検証ステップを追加し、マスタードキュメントが欠落している場合は明確なエラーを発生させることです。既存のエラーハンドリングと参照されている issue #11722 を確認してコンテキストを把握してください。
技術スタック
python
領域
documentation
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1時間未満
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
おおむね明確
前提条件
Basic PythonFamiliarity with Sphinx project structure
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
65