hanno una relazione sfinge collegamenti interrotti

Question

Quando si crea documentazione html, come si forza la sfinge a segnalare o creare un errore su collegamenti che non esistono?

In particolare, ho proprietà e metodi all'interno del mio progetto Python che sono stati rimossi o rinominati, ed è difficile trovare tutti i link morti con l'output html generato dalla sfinge.

Mi sento come se stessi fissando la risposta qui: http://sphinx-doc.org/glossary.html, come descritto nel paragrafo iniziale.

Ovviamente non capisco qualcosa.

Answer 1

Penso che CheckExternalLinksBuilder sia quello che stai cercando.

Viene utilizzato fondamentalmente chiamando "sphinx-build" con l'opzione -b linkcheck. Si prega di vedere sphinx-build per maggiori informazioni. Inoltre, dai un'occhiata alla lista delle sfinge-estensioni here e here.

Answer 2

Impostare la variabile di configurazione nitpicky su True (è anche possibile utilizzare -n option durante l'esecuzione di sphinx-build).

In modalità nitpicky, un riferimento incrociato a una funzione (come :func:`myfunc`), una classe o un altro oggetto che non può essere trovato genererà un messaggio di avviso.