Skip to content

Commit de976a3

Browse files
committed
fix(docs): use sphinx-multiversion-contrib for Sphinx 7+ compatibility
The original sphinx-multiversion package (0.2.4) is incompatible with Sphinx 7+ due to a changed Config.read() signature. Switch to the maintained sphinx-multiversion-contrib fork which fixes this.
1 parent 3857fd9 commit de976a3

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ jobs:
5555
- name: Create root redirect
5656
run: |
5757
# Find the latest tag that matches our whitelist, fall back to main
58-
LATEST_TAG=$(git tag --sort=-v:refname | grep -E '^v0\.([4-9]|[0-9]{2,})\.[0-9]+$|^v[1-9][0-9]*\.[0-9]+\.[0-9]+$' | head -1)
58+
LATEST_TAG=$(git tag --sort=-v:refname | grep -E '^v0\.4\.([1-9][0-9]*)$|^v0\.([5-9]|[0-9]{2,})\.[0-9]+$|^v[1-9][0-9]*\.[0-9]+\.[0-9]+$' | head -1)
5959
TARGET="${LATEST_TAG:-main}"
6060
cat > docs/_build/html/index.html << 'REDIRECT_EOF'
6161
<!DOCTYPE html>

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,8 @@
101101
]
102102

103103
# -- sphinx-multiversion options ---------------------------------------------
104-
# Tag whitelist: match v0.4.0+ and v1.0.0+ (skip old tags without docs/)
105-
smv_tag_whitelist = r"^v0\.(([4-9]|\d{2,})\.\d+)$|^v([1-9]\d*)\.\d+\.\d+$"
104+
# Tag whitelist: match v0.4.1+ and v1.0.0+ (v0.4.0 and earlier lack docs/)
105+
smv_tag_whitelist = r"^v0\.4\.([1-9]\d*)$|^v0\.([5-9]|\d{2,})\.\d+$|^v([1-9]\d*)\.\d+\.\d+$"
106106
smv_branch_whitelist = r"^main$"
107107
smv_remote_whitelist = r"^origin$"
108108
smv_released_pattern = r"^refs/tags/.*$"

docs/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ myst-nb>=1.0
44
sphinx-design>=0.5
55
sphinx-copybutton>=0.5
66
sphinx-favicon>=1.0
7-
sphinx-multiversion>=0.2.4
7+
sphinx-multiversion-contrib>=0.2.13
88
pyyaml>=6.0

0 commit comments

Comments
 (0)