Merge pull request #485 from jumpstarter-dev/backport-483-to-release-0.6

Backport #483 to release 0.6

Author: mangelajo

.gitignore

@@ -163,4 +163,4 @@ cython_debug/
 #.idea/
 
 # Ruff cache
-.ruff_cache/
+.ruff_cache/

docs/Makefile

@@ -26,13 +26,8 @@ serve:
 	sphinx-autobuild --host $(HOST) --port $(PORT) "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 multiversion:
-	sphinx-multiversion "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-	@if [ -d "$(BUILDDIR)/main" ]; then \
-		echo "Moving main directory contents to build root"; \
-		mv "$(BUILDDIR)/main/"* "$(BUILDDIR)/"; \
-		rm -rf "$(BUILDDIR)/main/"; \
-	fi
+	./multiversion.sh
 
 serve-multiversion:
 	@echo "Serving multiversion documentation using the HOST variable"
-	@cd "$(BUILDDIR)" && python -m http.server $(PORT) --bind $(HOST)
+	@cd "$(BUILDDIR)" && python -m http.server $(PORT) --bind $(HOST)

docs/multiversion.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+set -euox pipefail
+
+declare -a BRANCHES=("main" "release-0.5" "release-0.6")
+
+# https://stackoverflow.com/a/246128
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+OUTPUT_DIR="${SCRIPT_DIR}/build"
+
+rm    -rf "${OUTPUT_DIR}"
+mkdir -p  "${OUTPUT_DIR}"
+
+for BRANCH in "${BRANCHES[@]}"; do
+  WORKTREE="${OUTPUT_DIR}/.worktree/tmp-docs-${BRANCH}"
+
+  git worktree add --force    "${WORKTREE}" "${BRANCH}"
+
+  uv run --project "${WORKTREE}" --isolated --all-packages --group docs \
+    make -C "${WORKTREE}/docs" html SPHINXOPTS="-D version=${BRANCH}"
+
+  cp -r "${WORKTREE}/docs/build/html" "${OUTPUT_DIR}/${BRANCH}"
+
+  git worktree remove --force "${WORKTREE}"
+done
+
+pushd "${OUTPUT_DIR}"
+uvx --from git+https://github.com/steinwurf/versjon --with jinja2 versjon
+popd

docs/source/_templates/sidebar/versions.html

@@ -29,7 +29,6 @@
     "sphinx.ext.doctest",
     "sphinx_click",
     "sphinx_substitution_extensions",
-    "sphinx_multiversion",
     "sphinx_copybutton"
 ]
 
@@ -99,44 +98,13 @@ def get_index_url():
         "sidebar/scroll-start.html",
         "sidebar/navigation.html",
         "sidebar/scroll-end.html",
-        "sidebar/versions.html",
     ]
 }
 html_theme_options = {
     "sidebar_hide_name": True,
     "top_of_page_button": "edit",
 }
 
-# -- sphinx-multiversion configuration -------------------------------------
-# This replaces the custom bash script approach with built-in functionality
-
-# Tags pattern for html_context["versions"]
-smv_tag_whitelist = r"$^" # Ignore all tags
-smv_branch_whitelist = r"^(main|release-\d+\.\d+)$" # Include all release branches and main
-smv_remote_whitelist = r'^(origin|upstream)$' # Include branches from origin and upstream
-smv_prefer_remote_refs = True
-# smv_released_pattern = r"^v[0-9]+\.[0-9]+\.[0-9]+$"  # Tags that are considered releases
-smv_outputdir_format = "{ref.name}"  # Directory name format
-
-# Ensure static files are copied to all versions
-smv_static_files = [
-    "_static/**",
-    "_templates/**",
-]
-
-# Ensure RST directives are processed
-smv_include_patterns = [
-    "*.md",
-    "*.rst",
-    "*.txt",
-]
-
-# Patterns for the versions panel
-html_context = {
-    "display_lower": True,  # Display lower versions at the bottom of the menu
-    "deploy_url": os.getenv("DEPLOY_URL", "https://docs.jumpstarter.dev"),  # Get Netlify URL from environment variable
-}
-
 # sphinx-copybutton config
 copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
 copybutton_prompt_is_regexp = True

docs/source/conf.py

@@ -48,7 +48,6 @@ docs = [
     "sphinx-substitution-extensions>=2024.10.17",
     "requests>=2.32.3",
     "sphinxcontrib-programoutput>=0.18",
-    "sphinx-multiversion>=0.2.4",
     "sphinx-copybutton>=0.5.2",
 ]
 dev = [