sphinx-doc/sphinx

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

Open

#11,873 opened on 2024年1月12日

GitHub で見る
 (3 comments) (4 reactions) (0 assignees)Python (5,625 stars) (1,985 forks)batch import
good first issuehelp wanted

説明

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

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

技術スタック
python
領域
documentation
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
Basic PythonFamiliarity with Sphinx project structure
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
65
調査方針
The issue involves checking that the master document (index.rst) appears in the project documents after pattern application. The relevant code likely resides in sphinx/project/ init .py where document discovery happens. The goal is to add a validation step after discovering documents and raise a clear error if the master doc is missing. Review the existing error handling and the referenced issue #11722 for context.
Provide a better error message if the master document is not included in project documents · sphinx-doc/sphinx#11873 | Good First Issue