Сообщить модератору
При создании html-документации, как заставить sphinx сообщать или создавать ошибку на ссылках, которые не существуют?
В частности, у меня есть свойства и методы в моем проекте Python, которые были удалены или переименованы, и трудно найти все мертвые ссылки с созданным sphinx выходом html.
Мне кажется, что я смотрю на ответ здесь:
http://sphinx-doc.org/glossary.html, как описано в первом абзаце.
Я, очевидно, ничего не понимаю.
Ответы
Ответ 1
Установите для переменной конфигурации nitpicky значение True
(вы также можете использовать опцию -n при запуске sphinx-build).
В придирчивом режиме перекрестная ссылка на функцию (такую как :func:'myfunc'
), класс или другой объект, который не может быть найден, сгенерирует предупреждающее сообщение.
Ответ 2
Я думаю, CheckExternalLinksBuilder
это то, что вы ищете.
Он в основном используется при вызове sphinx-build с опцией -b linkcheck
. Пожалуйста, смотрите sphinx-build
для получения дополнительной информации. Кроме того, взгляните на список расширений сфинксов здесь и здесь.