docs: add dynamic substitutions

Author: dgarcia360

docs/source/_ext/__pycache__/scylladb_dynamic_substitutions.cpython-312.pyc

@@ -0,0 +1,57 @@
+"""Sphinx extension to add dynamic substitutions
+based on the current documentation version.
+
+Usage:
+
+Add substitutions like |CURRENT_VERSION| in your
+reStructuredText files.
+
+The extension will replace
+them with the appropriate values during the build process.
+"""
+
+import os
+from sphinx.application import Sphinx
+from sphinx.util import logging
+
+LOGGER = logging.getLogger(__name__)
+
+class DynamicSubstitutions:
+
+    def _get_current_version(self, app):
+        current_version = os.environ.get('SPHINX_MULTIVERSION_NAME', '')
+        stable_version = app.config.smv_latest_version
+        prefix = 'branch-'
+        version = current_version
+
+        if current_version.startswith(prefix):
+            version = current_version
+        elif not stable_version.startswith(prefix):
+            LOGGER.error("Invalid stable_version format in conf.py. It should start with 'branch-'")
+        else:
+            version = stable_version
+
+        return version.replace(prefix, '')
+
+    def run(self, app):
+        current_version = self._get_current_version(app)
+
+        if not hasattr(app.config, 'rst_prolog') or app.config.rst_prolog is None:
+            app.config.rst_prolog = ""
+        elif not app.config.rst_prolog.endswith('\n'):
+            app.config.rst_prolog += '\n'
+
+        app.config.rst_prolog += f"""
+.. |CURRENT_VERSION| replace:: {current_version}
+.. |UBUNTU_SCYLLADB_LIST| replace:: scylladb-manager-{current_version}.list
+.. |CENTOS_SCYLLADB_REPO| replace:: scylladb-manager-{current_version}.repo
+"""
+
+def setup(app: Sphinx):
+    app.connect("builder-inited",  DynamicSubstitutions().run)
+
+    return {
+        "version": "0.1",
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+    }

docs/source/_ext/scylladb_dynamic_substitutions.py

@@ -1,7 +1,10 @@
 # -*- coding: utf-8 -*-
+import os
+import sys
 from datetime import date
 
 from sphinx_scylladb_theme.utils import multiversion_regex_builder
+sys.path.insert(0, os.path.abspath('./_ext'))
 
 # -- Global variables
 
@@ -29,6 +32,7 @@
     "sphinx_sitemap",
     "sphinx_scylladb_theme",
     'sphinxcontrib.datatemplates',
+    "scylladb_dynamic_substitutions",
     "sphinx_multiversion",
     "recommonmark",
 ]