sphinx-doc/sphinx

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

Open

#11.873 aperta il 12 gen 2024

Vedi su GitHub
 (3 commenti) (4 reazioni) (0 assegnatari)Python (1985 fork)batch import
good first issuehelp wanted

Metriche repository

Star
 (5625 star)
Metriche merge PR
 (Merge medio 13g 10h) (8 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Il problema riguarda la verifica che il documento principale (index.rst) compaia nei documenti del progetto dopo l'applicazione del pattern. Il codice rilevante risiede probabilmente in sphinx/project/ init .py, dove avviene la scoperta dei documenti. L'obiettivo è aggiungere un passaggio di convalida dopo la scoperta dei documenti e generare un errore chiaro se il documento principale è mancante. Rivedere la gestione degli errori esistente e l'issue di riferimento #11722 per il contesto.
Tech stack
python
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Basic PythonFamiliarity with Sphinx project structure
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65