diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.rst | 7 | ||||
| -rw-r--r-- | doc/ext/appapi.rst | 8 |
2 files changed, 15 insertions, 0 deletions
diff --git a/doc/config.rst b/doc/config.rst index e4693d84..92542f8c 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -224,6 +224,13 @@ General configuration .. versionadded:: 1.0 +.. confval:: needs_sphinx + + If set to a ``major.minor`` version string like ``'1.1'``, Sphinx will + compare it with its version and refuse to build if it is too old. + + .. versionadded:: 1.0 + Project information ------------------- diff --git a/doc/ext/appapi.rst b/doc/ext/appapi.rst index 88bbe485..7652f97c 100644 --- a/doc/ext/appapi.rst +++ b/doc/ext/appapi.rst @@ -269,6 +269,14 @@ the following public API: .. versionadded:: 0.5 +.. method:: Sphinx.require_sphinx(version) + + Compare *version* (which must be a ``major.minor`` version string, + e.g. ``'1.1'``) with the version of the running Sphinx, and abort the build + when it is too old. + + .. versionadded:: 1.0 + .. exception:: ExtensionError |