mają sfinksować uszkodzone linki

Podczas budowania dokumentacji html, jak zmusić sfinksa do zgłaszania lub tworzenia błędów w linkach, które nie istnieją?mają sfinksować uszkodzone linki

W szczególności mam właściwości i metody w ramach mojego projektu Python, które zostały usunięte lub zmieniono ich nazwę, i trudno jest znaleźć wszystkie martwe linki z generowanym przez sfinksa wyjściem html.

Czuję, że patrzę na odpowiedź tutaj: http://sphinx-doc.org/glossary.html, jak opisano w pierwszym akapicie.

Oczywiście nie rozumiem czegoś.

Źródło

2013-01-24 Idaho

Myślę, że CheckExternalLinksBuilder jest tym, czego szukasz.

Jest to zasadniczo używane przez wywołanie "sphinx-build" z opcją -b linkcheck. Więcej informacji można znaleźć pod numerem sphinx-build. Zobacz także listę rozszerzeń sfinksa: here i here.

Źródło

2013-01-24 21:22:52 alecxe

To nie działa dla wyszukiwania właściwości i metod w moim projekcie Python, które zostały usunięte lub zmieniono jego nazwę. Wygląda na to, że działa tylko dla linków zewnętrznych. – Idaho

Ok, rozumiem. Nie jestem pewien, czy znalezienie zepsutych właściwości lub metod jest zadaniem Sphinx. Brzmi jak pylint, pyflakes to odpowiednie narzędzia do pracy. – alecxe

Ustaw zmienną konfiguracyjną nitpicky na True (możesz także użyć -n option podczas uruchamiania sphinx-build).

W trybie nitpicky odsyłacz do funkcji (np. :func:`myfunc`), klasy lub innego obiektu, który nie może zostać znaleziony, spowoduje wygenerowanie komunikatu ostrzegawczego.

Źródło

2013-02-06 17:22:13 mzjn

niesamowite, dodanie "nitpicky = True" w pliku conf.py projektów naprawiło to. – Idaho

bardzo ładna odpowiedź! czy istnieje sposób przekierowania tych ostrzeżeń do pliku? – jsmedmar

@jsmedmar, czy próbowałeś użyć opcji [** - w **] (http://www.sphinx-doc.org/en/stable/invocation.html#cmdoption-sphinx-build-w)? – mzjn

mają sfinksować uszkodzone linki

Odpowiedz

Powiązane problemy