whenxuan: create the version of docs

Author: wwhenxuan

README.md

@@ -3,6 +3,7 @@
 # PySDKit: signal decomposition in Python
 
 [![PyPI version](https://badge.fury.io/py/PySDKit.svg)](https://pypi.org/project/PySDKit/) 
+[![Documentation Status](https://readthedocs.org/projects/pysdkit/badge/?version=latest)](https://pysdkit.readthedocs.io/en/latest/)
 ![License](https://img.shields.io/github/license/wwhenxuan/PySDKit)
 [![Python](https://img.shields.io/badge/python-3.8+-blue?logo=python)](https://www.python.org/)
 [![Downloads](https://pepy.tech/badge/pysdkit)](https://pepy.tech/project/pysdkit)

docs/source/_static/theme_overrides.css

@@ -86,6 +86,11 @@ html[data-theme="light"] .sphx-glr-download code {
   letter-spacing: 0.02em;
 }
 
+html[data-theme="light"] .version-switcher__button {
+  border-color: rgba(0, 0, 0, 0.22);
+  font-weight: 600;
+}
+
 /* Hide the floating Read the Docs flyout so the header uses our logo.
    You can also uncheck Addons → Flyout in the RTD dashboard. */
 readthedocs-flyout {

docs/source/_static/version_switcher.json

@@ -1,8 +1,18 @@
 [
+    {
+        "name": "dev",
+        "version": "latest",
+        "url": "https://pysdkit.readthedocs.io/en/latest/"
+    },
+    {
+        "name": "0.4.55 (stable)",
+        "version": "stable",
+        "url": "https://pysdkit.readthedocs.io/en/stable/",
+        "preferred": true
+    },
     {
         "name": "0.4.55",
         "version": "0.4.55",
-        "url": "https://pysdkit.readthedocs.io/",
-        "preferred": true
+        "url": "https://pysdkit.readthedocs.io/en/0.4.55/"
     }
 ]

docs/source/conf.py

@@ -4,6 +4,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 from datetime import date
+import os
 import sys
 from pathlib import Path
 
@@ -124,15 +125,29 @@
 
 html_css_files = ["theme_overrides.css", "custom.css"]
 
+# All doc versions fetch this URL so old builds pick up new tags.
+# READTHEDOCS_VERSION is "latest", "stable", or the git tag (e.g. 0.4.55).
+_switcher_json = (
+    "https://pysdkit.readthedocs.io/en/latest/_static/version_switcher.json"
+)
+_version_match = os.environ.get("READTHEDOCS_VERSION") or "latest"
+
 html_theme_options = {
     "announcement": "",
     "logo": {
         "image_light": "_static/logo.png",
         "image_dark": "_static/logo.png",
-        "text": "PYSDKIT",
+        "text": "PySDKit",
         "alt_text": "PySDKit",
         "link": "https://pysdkit.readthedocs.io/",
     },
+    "switcher": {
+        "json_url": _switcher_json,
+        "version_match": _version_match,
+    },
+    # First deploy of the JSON on latest would otherwise fail the check.
+    "check_switcher": False,
+    "show_version_warning_banner": True,
     "header_links_before_dropdown": 6,
     "icon_links": [
         {
@@ -151,7 +166,7 @@
     "navbar_align": "content",
     "navbar_start": ["navbar-logo"],
     "navbar_center": ["navbar-nav"],
-    "show_version_warning_banner": False,
+    "navbar_end": ["version-switcher", "theme-switcher", "navbar-icon-links"],
     "secondary_sidebar_items": {
         "**": ["page-toc", "sourcelink"],
     },