feat(theme)!: rename version_slug to version_id

Author: aksiome

docs/conf.py

@@ -100,7 +100,7 @@
 
 # -- Options for theme development -------------------------------------------
 
-version_slug = os.environ.get("READTHEDOCS_VERSION", "latest")
+version_id = os.environ.get("READTHEDOCS_VERSION", "latest")
 
 templates_path = ["_templates"]
 
@@ -112,11 +112,11 @@
     "github_repo": "breeze",
     "github_version": "main",
     "doc_path": "docs",
-    "version_slug": version_slug,
+    "version_id": version_id,
     "version_switcher_url": "https://raw.githubusercontent.com/aksiome/breeze/refs/heads/main/docs/_static/switcher.json",
     "languages": [
-        ("English", f"/en/{version_slug}/%s/", "en"),
-        ("Français", f"/fr/{version_slug}/%s/", "fr"),
-        ("中文", f"/zh/{version_slug}/%s/", "zh"),
+        ("English", f"/en/{version_id}/%s/", "en"),
+        ("Français", f"/fr/{version_id}/%s/", "fr"),
+        ("中文", f"/zh/{version_id}/%s/", "zh"),
     ],
 }

docs/user_guide/components/lang-switcher.md

@@ -38,12 +38,12 @@ For Read the Docs hosted documentation, use environment variables for dynamic ve
 ```python
 import os
 
-version_slug = os.environ.get("READTHEDOCS_VERSION", "latest")
+version_id = os.environ.get("READTHEDOCS_VERSION", "latest")
 
 html_context = {
     "languages": [
-        ("English", f"/en/{version_slug}/%s/", "en"),
-        ("Français", f"/fr/{version_slug}/%s/", "fr"),
+        ("English", f"/en/{version_id}/%s/", "en"),
+        ("Français", f"/fr/{version_id}/%s/", "fr"),
     ],
 }
 ```

docs/user_guide/components/version-switcher.md

@@ -8,14 +8,14 @@ Configure the version switcher via `html_context` in `conf.py`:
 
 ```python
 html_context = {
-    "version_slug": "v2.0",
+    "version_id": "v2.0",
     "version_switcher_url": "https://example.com/docs/_static/switcher.json",
 }
 ```
 
 | Key | Description |
 |-----|-------------|
-| `version_slug` | The currently displayed version |
+| `version_id` | The currently displayed version |
 | `version_switcher_url` | URL to the JSON file containing version data |
 
 ## Version JSON format
@@ -48,7 +48,7 @@ Each version object accepts:
 | Key | Description |
 |-----|-------------|
 | `name` | Display name in dropdown |
-| `version` | Version identifier (matches `version_slug`) |
+| `version` | Version identifier (matches `version_id`) |
 | `url` | Base URL for this version |
 | `preferred` | Optional. Mark as the recommended version |
 
@@ -59,10 +59,10 @@ For Read the Docs, use environment variables:
 ```python
 import os
 
-version_slug = os.environ.get("READTHEDOCS_VERSION", "latest")
+version_id = os.environ.get("READTHEDOCS_VERSION", "latest")
 
 html_context = {
-    "version_slug": version_slug,
+    "version_id": version_id,
     "version_switcher_url": "https://raw.githubusercontent.com/org/repo/main/docs/_static/switcher.json",
 }
 ```

src/sphinx_breeze_theme/theme/breeze/components/version-switcher.html

@@ -1,16 +1,16 @@
-{%- if version_slug and version_switcher_url -%}
+{%- if version_id and version_switcher_url -%}
 <div class="bz-version-switcher bz-dropdown">
   <button
     aria-label="{{ _('Change version') }}"
     aria-haspopup="true"
     aria-expanded="false"
     data-url="{{ version_switcher_url }}"
-    data-current="{{ version_slug }}"
+    data-current="{{ version_id }}"
   >
     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" fill="currentColor">
       <path d="M1 7.775V2.75C1 1.784 1.784 1 2.75 1h5.025c.464 0 .91.184 1.238.513l6.25 6.25a1.75 1.75 0 0 1 0 2.474l-5.026 5.026a1.75 1.75 0 0 1-2.474 0l-6.25-6.25A1.752 1.752 0 0 1 1 7.775Zm1.5 0c0 .066.026.13.073.177l6.25 6.25a.25.25 0 0 0 .354 0l5.025-5.025a.25.25 0 0 0 0-.354l-6.25-6.25a.25.25 0 0 0-.177-.073H2.75a.25.25 0 0 0-.25.25ZM6 5a1 1 0 1 1 0 2 1 1 0 0 1 0-2Z"></path>
     </svg>
-    <span>{{ version_slug }}</span>
+    <span>{{ version_id }}</span>
   </button>
   <ul role="menu" aria-hidden="true"></ul>
 </div>