Skip to content

Commit

Permalink
Merge pull request #9447 from Blendify/Blendify/html-templates-sphinx…
Browse files Browse the repository at this point in the history
…-version

HTML Templates: Expose full sphinx version tuple
  • Loading branch information
tk0miya committed Aug 1, 2021
2 parents efea26f + 4d0f497 commit 641174d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
11 changes: 10 additions & 1 deletion doc/templating.rst
Expand Up @@ -372,7 +372,16 @@ in the future.

.. data:: sphinx_version

The version of Sphinx used to build.
The version of Sphinx used to build represented as a string for example "3.5.1".

.. data:: sphinx_version_tuple

The version of Sphinx used to build represented as a tuple of five elements.
For Sphinx version 3.5.1 beta 3 this would be `(3, 5, 1, 'beta', 3)``.
The fourth element can be one of: ``alpha``, ``beta``, ``rc``, ``final``.
``final`` always has 0 as the last element.

.. versionadded:: 4.2

.. data:: style

Expand Down
2 changes: 2 additions & 0 deletions sphinx/builders/html/__init__.py
Expand Up @@ -26,6 +26,7 @@
from docutils.utils import relative_path

from sphinx import __display_version__, package_dir
from sphinx import version_info as sphinx_version
from sphinx.application import Sphinx
from sphinx.builders import Builder
from sphinx.config import ENUM, Config
Expand Down Expand Up @@ -516,6 +517,7 @@ def prepare_writing(self, docnames: Set[str]) -> None:
'language': self.config.language,
'css_files': self.css_files,
'sphinx_version': __display_version__,
'sphinx_version_tuple': sphinx_version,
'style': self._get_style_filename(),
'rellinks': rellinks,
'builder': self.name,
Expand Down

0 comments on commit 641174d

Please sign in to comment.