Fix docs better (#117)

Signed-off-by: Adam Li <[email protected]>
py-why · Jul 18, 2024 · 41ec6b6 · 41ec6b6
1 parent 8a997d4
commit 41ec6b6
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 45 deletions.
diff --git a/doc/_static/versions.json b/doc/_static/versions.json
@@ -0,0 +1,12 @@
+[
+    {
+        "name": "0.2 (devel)",
+        "version": "dev",
+        "url": "https://www.pywhy.org/pywhy-graphs/dev/index.html"
+    },
+    {
+        "name": "0.1",
+        "version": "stable",
+        "url": "https://www.pywhy.org/pywhy-graphs/stable/index.html"
+    }
+]
diff --git a/doc/_templates/docs-navbar.html b/doc/_templates/docs-navbar.html
diff --git a/doc/_templates/docs-toc.html b/doc/_templates/docs-toc.html
diff --git a/doc/_templates/version-switcher.html b/doc/_templates/version-switcher.html
diff --git a/doc/conf.py b/doc/conf.py
@@ -36,6 +36,7 @@
 copyright = f"{datetime.today().year}, Adam Li"
 author = "Adam Li"
 version = pywhy_graphs.__version__
+release = version
 
 # -- General configuration ---------------------------------------------------
 
@@ -270,6 +271,7 @@ def setup(app):
 html_css_files = ["css/custom.css"]
 html_favicon = "_static/favicon_url.ico"
 
+switcher_version_match = "dev" if "dev" in release else version
 html_theme_options = {
     "icon_links": [
         dict(
@@ -281,7 +283,11 @@ def setup(app):
     "use_edit_page_button": False,
     "navigation_with_keys": False,
     "show_toc_level": 1,
-    "navbar_end": ["version-switcher", "navbar-icon-links"],
+    "navbar_end": ["theme-switcher", "version-switcher", "navbar-icon-links"],
+    "switcher": {
+        "json_url": "https://raw.githubusercontent.com/neurodata/treeple/main/doc/_static/versions.json",  # noqa: E501
+        "version_match": switcher_version_match,
+    },
 }
 
 scrapers = ("matplotlib",)