summaryrefslogtreecommitdiff
path: root/doc/ext/appapi.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ext/appapi.rst')
-rw-r--r--doc/ext/appapi.rst8
1 files changed, 8 insertions, 0 deletions
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