From f7fe7daea6b0ceec25125b7a63ac2df3860295c0 Mon Sep 17 00:00:00 2001
From: Stephen Finucane <sfinucan@redhat.com>
Date: Fri, 15 May 2020 16:54:47 +0100
Subject: [PATCH] Provide extension version

This can be useful for debugging purposes, though others may also use it
if they wish to depend on the extension for some reason.

Change-Id: I485201946dfb486a0045ac36fced7c3c27673f4f
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
---
 openstackdocstheme/__init__.py     | 9 +++++++--
 openstackdocstheme/ext.py          | 8 +++++++-
 openstackdocstheme/page_context.py | 4 ++++
 openstackdocstheme/version.py      | 2 +-
 4 files changed, 19 insertions(+), 4 deletions(-)

diff --git a/openstackdocstheme/__init__.py b/openstackdocstheme/__init__.py
index 0904878d..d6bab95b 100644
--- a/openstackdocstheme/__init__.py
+++ b/openstackdocstheme/__init__.py
@@ -12,9 +12,13 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
-from . import ext  # noqa
-from . import page_context  # noqa
+from . import ext
+from . import page_context
 from .paths import *  # noqa
+from .version import version_info
+
+
+__version__ = version_info.version_string()
 
 
 def setup(app):
@@ -23,4 +27,5 @@ def setup(app):
     return {
         'parallel_read_safe': True,
         'parallel_write_safe': True,
+        'version': __version__,
     }
diff --git a/openstackdocstheme/ext.py b/openstackdocstheme/ext.py
index 41e475df..5ac9c3f3 100644
--- a/openstackdocstheme/ext.py
+++ b/openstackdocstheme/ext.py
@@ -25,6 +25,7 @@ from pbr import packaging
 from sphinx.ext import extlinks
 from sphinx.util import logging
 
+from . import version
 from openstackdocstheme import paths
 
 _series = None
@@ -308,7 +309,11 @@ def _get_project_name(srcdir):
 
 def _builder_inited(app):
     theme_dir = paths.get_html_theme_path()
-    logger.info('Using openstackdocstheme Sphinx theme from %s' % theme_dir)
+    logger.info(
+        '[openstackdocstheme] using theme from %s (version %s)',
+        theme_dir,
+        version.version_info.version_string(),
+    )
 
     if app.config.openstack_projects is not None:
         logger.info(
@@ -449,4 +454,5 @@ def setup(app):
     return {
         'parallel_read_safe': True,
         'parallel_write_safe': True,
+        'version': version.version_info.version_string(),
     }
diff --git a/openstackdocstheme/page_context.py b/openstackdocstheme/page_context.py
index c4c93c15..476a2810 100644
--- a/openstackdocstheme/page_context.py
+++ b/openstackdocstheme/page_context.py
@@ -18,6 +18,9 @@ import time
 
 from sphinx.util import logging
 
+from . import version
+
+
 LOG = logging.getLogger(__name__)
 
 _timeint = int(os.environ.get('SOURCE_DATE_EPOCH', time.time()))
@@ -99,4 +102,5 @@ def setup(app):
     return {
         'parallel_read_safe': True,
         'parallel_write_safe': True,
+        'version': version.version_info.version_string(),
     }
diff --git a/openstackdocstheme/version.py b/openstackdocstheme/version.py
index 57b90fb4..98f7eda8 100644
--- a/openstackdocstheme/version.py
+++ b/openstackdocstheme/version.py
@@ -14,4 +14,4 @@
 
 import pbr.version
 
-version_info = pbr.version.VersionInfo('openstackdoctheme')
+version_info = pbr.version.VersionInfo('openstackdocstheme')