sphinx-action icon indicating copy to clipboard operation
sphinx-action copied to clipboard

Fail build for sphinx error (and warning)

Open tdegeus opened this issue 3 years ago • 1 comments

Thanks for the nice action! I was wondering though, can I also fail my build on sphinx errors and warnings?

tdegeus avatar Feb 23 '21 09:02 tdegeus

Sorry for the late reply Tom, but you should be able to use the Sphinx option:

-W Turn warnings into errors. This means that the build stops at the first warning and sphinx-build exits with exit status 1.

Follow the example in the advanced usage section and use a custom build command like

build-command: "sphinx-build -W -b html . _build"

ammaraskar avatar Apr 27 '21 14:04 ammaraskar