sphinx-doc/sphinx

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

Open

#11 873 ouverte le 12 janv. 2024

Voir sur GitHub
 (3 commentaires) (4 réactions) (0 assignés)Python (1 985 forks)batch import
good first issuehelp wanted

Métriques du dépôt

Stars
 (5 625 stars)
Métriques de merge PR
 (Merge moyen 13j 10h) (8 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Le problème concerne la vérification que le document maître (index.rst) apparaît dans les documents du projet après l'application du motif. Le code pertinent se trouve probablement dans sphinx/project/ init .py où la découverte des documents a lieu. L'objectif est d'ajouter une étape de validation après la découverte des documents et de lever une erreur claire si le document maître est manquant. Examinez la gestion des erreurs existante et l'issue de référence #11722 pour le contexte.
Stack technique
python
Domaine
documentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Basic PythonFamiliarity with Sphinx project structure
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65