Sphinx should exit with non zero exit code on error

[shimizukawa]

When Sphinx encounters an error, it currently exits with a exit code of zero. That doesn't work well with makefile and buildbots etc. We had several issues with silently failing doc builds.

---

• Bitbucket: https://bitbucket.org/birkenfeld/sphinx/issue/508
• Originally reported by: Anonymous
• Originally created at: 2010-08-19T15:30:10.626

[shimizukawa]

From Georg Brandl on 2010-08-23 13:29:11+00:00

In case of an error, Sphinx already exits with nonzero exit code. However, non-severe docutils errors are not considered errors and made warnings instead.

If you like warnings to be errors, use the -W option to sphinx-build.

[shimizukawa]

From Kostis Anagnostopoulos on 2014-08-23 04:27:19+00:00

This bug is still there for builders invoked through the setup.py command!

For instance, the doctest builder:

• When run with sphinx-build -b doctest, the process exits with error-code 1, as it should.
• But when i run python setup.py build_sphinx -b doctest the error-code is 0.

It seems the sphinx/setup_command.py:BuildDoc.run() is missing a final clause to check status-code of the selected builder.

My sphinx version:

#!bash

$ pip show sphinx
---
Name: Sphinx
Version: 1.2.2

[shimizukawa]

From Takayuki Shimizukawa on 2014-08-28 16:16:15+00:00

Now Sphinx exits with non-zero status code if builder status is not success. Closes #508.

→ <>

[shimizukawa]

From Georg Brandl on 2014-10-18 07:29:51+00:00

Removing version: 1.0.2 (automated comment)