summaryrefslogtreecommitdiff
path: root/doc/ext/appapi.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-01-17 18:29:16 +0100
committerGeorg Brandl <georg@python.org>2010-01-17 18:29:16 +0100
commit50cb36da7d8d6436f40aacd63709b58e4459220a (patch)
tree59a06b108522d2452fe084a2c80b106bdce86fe3 /doc/ext/appapi.rst
parent8068e49908a76448e405273dff83ceb670435e77 (diff)
parent295e4e7ee85020cb7f4ed67ddc586b3d08b3d195 (diff)
downloadsphinx-50cb36da7d8d6436f40aacd63709b58e4459220a.tar.gz
merge with trunk
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 12d004a1..a643a478 100644
--- a/doc/ext/appapi.rst
+++ b/doc/ext/appapi.rst
@@ -296,6 +296,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