OpenE2K
/
qemu-e2k
13
4
Fork 0
Code Issues 4 Pull Requests Projects 2 Releases Activity

docs/conf.py: Raise ConfigError for bad Sphinx Python version 

Raise ConfigError rather than VersionRequirementError when we detect
that the Python being used by Sphinx is too old.

Currently the way we flag the Python version problem up to the user
causes Sphinx to print an unnecessary Python stack trace as well as
the information about the problem; in most versions of Sphinx this is
unavoidable.

The upstream Sphinx developers kindly added a feature to allow
conf.py to report errors to the user without the backtrace:
  be608ca231
but the exception type they chose for this was ConfigError.

Switch to ConfigError, which won't make any difference with currently
deployed Sphinx versions, but will be prettier one day when the user
is using a Sphinx version with the new feature.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: John Snow <jsnow@redhat.com>
Message-id: 20200313163616.30674-1-peter.maydell@linaro.org
This commit is contained in:
Peter Maydell 2020-03-30 13:18:59 +01:00
parent 34d8df2a1d
commit e22684e34d
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/conf.py
View File

@ -29,14 +29,15 @@
import os import os
import sys import sys
import sphinx import sphinx
from sphinx.errors import VersionRequirementError from sphinx.errors import ConfigError
# Make Sphinx fail cleanly if using an old Python, rather than obscurely # Make Sphinx fail cleanly if using an old Python, rather than obscurely
# failing because some code in one of our extensions doesn't work there. # failing because some code in one of our extensions doesn't work there.
# Unfortunately this doesn't display very neatly (there's an unavoidable # In newer versions of Sphinx this will display nicely; in older versions
# Python backtrace) but at least the information gets printed... # Sphinx will also produce a Python backtrace but at least the information
# gets printed...
if sys.version_info < (3,5): if sys.version_info < (3,5):
raise VersionRequirementError( raise ConfigError(
"QEMU requires a Sphinx that uses Python 3.5 or better\n") "QEMU requires a Sphinx that uses Python 3.5 or better\n")
# The per-manual conf.py will set qemu_docdir for a single-manual build; # The per-manual conf.py will set qemu_docdir for a single-manual build;