Georg Brandl avatar Georg Brandl committed 2ac9033

Add sphinx.version_info for better programmatic check of the Sphinx version.

Comments (0)

Files changed (2)

doc/ext/appapi.rst

    .. 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:
 
 The template bridge

sphinx/__init__.py

 
 __version__  = '1.2b3'
 __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__))
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.