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.