falconry/falcon

Doc: Explore Sphinx options if there is a flag to emit a warning on broken links

Open

#1 888 ouverte le 16 mars 2021

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)Python (925 forks)batch import
documentationgood first issueneeds contributor

Métriques du dépôt

Stars
 (9 293 stars)
Métriques de merge PR
 (Merge moyen 2j 7h) (9 PRs mergées en 30 j)

Description

Setting nitpicky = True in conf.py or passing the -n command line argument will warn on broken links.

Guide contributeur

Direction de recherche
Consultez la documentation Sphinx pour l'option 'nitpicky' et comment activer les avertissements sur les liens brisés.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
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.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90