sphinx-doc/sphinx

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

已关闭

#11,873 创建于 2024年1月12日

在 GitHub 查看贡献者指南
 (3 条评论) (4 个反应) (0 位负责人)Python (1,985 个派生)batch import
good first issuehelp wanted

仓库指标

星标
 (5,625 个星标)
PR 合并指标
 (平均合并 10天 11小时) (30 天内合并 11 个 PR)

描述

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
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1 小时以内
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
新近可参与
清晰度议题是否清楚说明期望改动、验收标准和下一步。
基本清晰
前置要求
Basic PythonFamiliarity with Sphinx project structure
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65