diff options
| author | Georg Brandl <georg@python.org> | 2010-01-17 18:24:35 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2010-01-17 18:24:35 +0100 |
| commit | 295e4e7ee85020cb7f4ed67ddc586b3d08b3d195 (patch) | |
| tree | fc4e18113c037d1ba74e6996f613e90e42fb5d37 /doc/ext/appapi.rst | |
| parent | 9d05e3734252d12bd624b636152797a882f9f3df (diff) | |
| download | sphinx-295e4e7ee85020cb7f4ed67ddc586b3d08b3d195.tar.gz | |
Added ``needs_sphinx`` config value and ``Sphinx.require_sphinx`` application API function.
Diffstat (limited to 'doc/ext/appapi.rst')
| -rw-r--r-- | doc/ext/appapi.rst | 8 |
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 |