mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-10-13 08:52:13 -05:00
Add sphinx.version_info for better programmatic check of the Sphinx version.
This commit is contained in:
1 parent
d79131c680
commit
695cebd254
2 files changed
+19
No files matched your search
@@ -462,6 +462,22 @@ registered event handlers.
|
|||||||
.. versionadded:: 0.5
|
.. versionadded:: 0.5
|
||||||
|
|
||||||
|
|
||||||
|
Checking the Sphinx version
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
.. currentmodule:: sphinx
|
||||||
|
|
||||||
|
Use this to adapt your extension to API changes in Sphinx.
|
||||||
|
|
||||||
|
.. data:: version_info
|
||||||
|
|
||||||
|
A tuple of five elements; for Sphinx version 1.2.1 beta 3 this would be
|
||||||
|
``(1, 2, 1, 'beta', 3)``.
|
||||||
|
|
||||||
|
.. versionadded:: 1.2
|
||||||
|
Before version 1.2, check the string ``sphinx.__version__``.
|
||||||
|
|
||||||
|
|
||||||
.. _template-bridge:
|
.. _template-bridge:
|
||||||
|
|
||||||
The template bridge
|
The template bridge
|
||||||
|
|||||||
@@ -17,6 +17,9 @@ from os import path
|
|||||||
|
|
||||||
__version__ = '1.2b3'
|
__version__ = '1.2b3'
|
||||||
__released__ = '1.2b3' # used when Sphinx builds its own docs
|
__released__ = '1.2b3' # used when Sphinx builds its own docs
|
||||||
|
# version info for better programmatic use
|
||||||
|
# possible values for 3rd element: 'alpha', 'beta', 'rc', 'final'
|
||||||
|
version_info = (1, 2, 0, 'beta', 3)
|
||||||
|
|
||||||
package_dir = path.abspath(path.dirname(__file__))
|
package_dir = path.abspath(path.dirname(__file__))
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user