New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fail build for sphinx error (and warning) #24

Open

tdegeus opened this issue Feb 23, 2021 · 1 comment

tdegeus commented Feb 23, 2021

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

Owner

ammaraskar commented Apr 27, 2021

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"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment