falconry/falcon

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

Open

#1888 aperta il 16 mar 2021

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)Python (925 fork)batch import
documentationgood first issueneeds contributor

Metriche repository

Star
 (9293 star)
Metriche merge PR
 (Merge medio 2g 7h) (9 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Controlla la documentazione di Sphinx per l'opzione 'nitpicky' e come abilitare gli avvisi sui collegamenti interrotti.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
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.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90