sphinx-doc/sphinx

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

Open

#11.873 geöffnet am 12. Jan. 2024

Auf GitHub ansehen
 (3 Kommentare) (4 Reaktionen) (0 zugewiesene Personen)Python (1.985 Forks)batch import
good first issuehelp wanted

Repository-Metriken

Stars
 (5.625 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 13T 10h) (8 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Das Problem betrifft die Überprüfung, ob das Hauptdokument (index.rst) nach der Musteranwendung in den Projektdokumenten erscheint. Der relevante Code befindet sich wahrscheinlich in sphinx/project/ init .py, wo die Dokumententdeckung stattfindet. Das Ziel ist es, einen Validierungsschritt nach der Dokumententdeckung hinzuzufügen und einen klaren Fehler auszulösen, wenn das Hauptdokument fehlt. Überprüfen Sie die vorhandene Fehlerbehandlung und das referenzierte Issue #11722 für den Kontext.
Tech Stack
python
Domain
documentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Basic PythonFamiliarity with Sphinx project structure
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65