Наш проект Python с открытым исходным кодом ( PyAbel ) использует readthedocs.org для автоматического создания документации для каждого запроса на извлечение с использованием Sphinx. Мы бы хотели, чтобы сборка do c завершилась сбоем, если есть какие-либо предупреждения от Sphinx, поскольку они обычно указывают на то, что некоторая часть документации не собирается правильно.
В настоящее время мы включаем sphinx: fail_on_warning: true в наш файл .readthedocs.yml. Это приводит к сбою сборки Sphinx при первом предупреждении. Пока все хорошо!
Однако на моем локальном компьютере я могу использовать
make html SPHINXOPTS="-W --keep-going"
, чтобы позволить сборке завершиться (показывая все предупреждения), а затем потерпеть неудачу, как обсуждено здесь . (В качестве альтернативы я могу включить SPHINXOPTS="-W --keep-going" в doc / Makefile для достижения того же результата.)
Такое поведение кажется лучшим вариантом, так как мы получаем все предупреждения, которые нам нужно исправить, и сборка все еще не удается, поэтому мы знаем, что нам нужно их исправить. Но я не могу понять, как этого добиться, когда документация построена на readthedocs.org. При создании документации Sphinx на readthedocs.org существует ли способ, которым мы можем увидеть все предупреждения из сборки Sphinx и затем все еще вызвать ошибку?
Некоторое связанное обсуждение здесь .