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