WIP

Author: Nicoretti

doc/_templates/version.html

@@ -38,6 +38,7 @@
     "sphinx_design",
     "sphinx_inline_tabs",
     "sphinx_copybutton",
+    "exasol.toolbox.sphinx.multiversion"
 ]
 
 intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
@@ -61,6 +62,11 @@
 
 # -- Options for HTML output -------------------------------------------------
 
+## Multi version output configuration
+smv_tag_whitelist = r'^.*$'                   # Include all tags
+smv_branch_whitelist = r'(master|main)'                # Include all branches
+smv_remote_whitelist = None                   # Only use local branches
+
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #

doc/conf.py

@@ -20,6 +20,7 @@
 """
 
 from exasol.toolbox.sphinx.multiversion.main import main
+from exasol.toolbox.sphinx.multiversion.sphinx import setup
 
 __version__ = "0.1.0"
 

exasol/toolbox/sphinx/multiversion/__init__.py

@@ -566,7 +566,7 @@ def _main(args, argv):
                     export_to_destination(matches, export_dst)
 
         with resources.path(
-            "exasol.sphinx_extensions.multiversion.templates", "multiversion-index.html"
+            "exasol.toolbox.sphinx.multiversion.templates", "multiversion-index.html"
         ) as p:
             with open(p, encoding="utf-8") as f:
                 template = Template(f.read())

exasol/toolbox/sphinx/multiversion/main.py

@@ -94,8 +94,29 @@ def in_development(self):
         ]
 
     def __iter__(self):
-        yield from self.tags
+        def to_int(v):
+            if v == '':
+                return 0
+            return int(v, base=0)
+
+        def version_key(version):
+            version = version.strip()
+            parts = version.split(".")
+            try:
+                major = int(parts[0])
+                minor = int(parts[1])
+                patch = int(parts[2])
+            except ValueError as ex:
+                print(f'version:{version} <<')
+                print(f'parts:{parts} <<')
+                print(ex)
+            return (
+                major,
+                minor,
+                patch
+            )
         yield from self.branches
+        yield from sorted(self.tags, key=lambda v: version_key(v.name), reverse=True)
 
     def __getitem__(self, name):
         v = self.metadata.get(name)
@@ -183,7 +204,8 @@ def html_page_context(app, pagename, templatename, context, doctree):
     context["vhasdoc"] = versioninfo.vhasdoc
     context["vpathto"] = versioninfo.vpathto
 
-    context["current_version"] = versioninfo[app.config.smv_current_version]
+    current = versioninfo[app.config.smv_current_version]
+    context["current_version"] = current.name
     context["latest_version"] = versioninfo[app.config.smv_latest_version]
     context["html_theme"] = app.config.html_theme
 

exasol/toolbox/sphinx/multiversion/sphinx.py

@@ -55,9 +55,9 @@ sphinx-copybutton = "^0.5.0"
 sphinx-inline-tabs = "^2023.4.21"
 sphinx-design = ">=0.5.0,<1"
 typer = {extras = ["all"], version = ">=0.7.0"}
-
-
 bandit = {extras = ["toml"], version = "^1.7.9"}
+jinja2 = "^3.1.4"
+
 [tool.poetry.group.dev.dependencies]
 autoimport = "^1.4.0"
 
@@ -110,3 +110,4 @@ ignore_errors = true
 
 [tool.poetry.scripts]
 tbx = 'exasol.toolbox.tools.tbx:CLI'
+sphinx-multiversion = 'exasol.toolbox.sphinx.multiversion:main'

poetry.lock

@@ -0,0 +1,4 @@
+from exasol.toolbox.sphinx.multiversion.main import main
+
+
+main()