sphinx-doc/sphinx

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

Open

#11,873 建立於 2024年1月12日

在 GitHub 查看
 (3 留言) (4 反應) (0 負責人)Python (5,625 star) (1,985 fork)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
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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