From 4c9cad2552ebeb96f747467017ef3155595a9d1c Mon Sep 17 00:00:00 2001
From: Hassan Abouelela <hassan@hassanamr.com>
Date: Wed, 11 May 2022 04:08:42 +0400
Subject: Add Sphinx-MultiVersion

Adds the sphinx-multiversion package to be used for generating docs
for all versions of the project, not just the latest. This includes
all the necessary configuration to make it work cleanly.

Signed-off-by: Hassan Abouelela <hassan@hassanamr.com>
---
 docs/_templates/base.html               | 12 +++++++++
 docs/_templates/sidebar/navigation.html | 46 +++++++++++++++++++++++++++++++++
 2 files changed, 58 insertions(+)
 create mode 100644 docs/_templates/base.html
 create mode 100644 docs/_templates/sidebar/navigation.html

(limited to 'docs/_templates')

diff --git a/docs/_templates/base.html b/docs/_templates/base.html
new file mode 100644
index 00000000..541dbd0b
--- /dev/null
+++ b/docs/_templates/base.html
@@ -0,0 +1,12 @@
+{% extends "furo/base.html" %}
+
+{# Make sure the project name uses the correct version #}
+{% if versions %}
+    {% if current_version == latest_version %}
+        {% set docstitle = "Latest (" + current_version.version + ")" %}
+    {% else %}
+        {% set docstitle = current_version.name %}
+    {% endif %}
+
+    {% set docstitle = project + " " + docstitle %}
+{% endif %}
diff --git a/docs/_templates/sidebar/navigation.html b/docs/_templates/sidebar/navigation.html
new file mode 100644
index 00000000..02239887
--- /dev/null
+++ b/docs/_templates/sidebar/navigation.html
@@ -0,0 +1,46 @@
+<div class="sidebar-tree">
+    {{ furo_navigation_tree }}
+
+    {# Include a version navigation menu in the side bar #}
+    {% if versions %}
+    <ul>
+        <li class="toctree-l1 has-children {{ "current-page" if pagename == "versions" }}">
+            {# The following block is taken from furo's generated sidebar dropdown #}
+            <a class="reference internal" href="{{ pathto("versions") }}">Versions</a>
+            <input {{ "checked" if pagename == "versions" }} class="toctree-checkbox" id="toctree-checkbox-versions" name="toctree-checkbox-versions" role="switch" type="checkbox">
+            <label for="toctree-checkbox-versions">
+                <div class="visually-hidden">Toggle child pages in navigation</div>
+                <i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i>
+            </label>
+            {# End copied block #}
+
+            <ul>
+                {% for version in versions | reverse %}
+                    <li class="toctree-l2 {{ "current-page" if version == current_version }}">
+                        <a class="version_link reference internal" href="{{ version.url }}">{{ version.name }}</a>
+                    </li>
+                {% endfor %}
+
+                <script>
+                    // Make sure we keep any hyperlinked resources when switching version
+                    function updateHash() {
+                        for (let tag of document.getElementsByClassName("version_link")) {
+                            // Extract the original URL
+                            let destination = tag.getAttribute("href");
+                            if (destination.indexOf("#") !== -1) {
+                                destination = destination.slice(0, destination.indexOf("#"));
+                            }
+
+                            // Update the url with the current hash
+                            tag.setAttribute("href", destination + document.location.hash);
+                        }
+                    }
+
+                    updateHash();
+                    addEventListener("hashchange", _ => { updateHash() });
+                </script>
+            </ul>
+        </li>
+    </ul>
+    {% endif %}
+</div>
-- 
cgit v1.2.3