Skip to content

Commit 0d3593b

Browse files
committed
fix: update Sphinx documentation build process and remove sphinx-multiversion
1 parent 1562f7f commit 0d3593b

3 files changed

Lines changed: 7 additions & 17 deletions

File tree

.github/workflows/main.yml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,13 @@ jobs:
3232
run: |
3333
uv pip install ."[docs]"
3434
35-
- name: Build versioned docs with sphinx-multiversion
35+
- name: Build versioned docs with sphinx
3636
run: |
37-
uv run sphinx-multiversion docs/ docs/_build/html
38-
37+
uv run python -m sphinx -b html docs/ docs/_build/html
38+
git reset --hard
39+
git fetch --prune --unshallow
40+
git checkout v0.3.10
41+
uv run python -m sphinx -b html docs/ docs/_build/html/v0.3.10
3942
4043
- name: Upload artifact
4144
uses: actions/upload-pages-artifact@v3

docs/conf.py

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
extensions = [
1717
"sphinx.ext.autosummary",
1818
"sphinx.ext.autodoc",
19-
"sphinx_multiversion",
2019
]
2120

2221
templates_path = ["_templates"]
@@ -28,14 +27,3 @@
2827

2928
html_theme = "sphinx_rtd_theme"
3029
html_static_path = ["_static"]
31-
32-
# Ensure the version selector sidebar is always included
33-
html_sidebars = {
34-
"**": [
35-
"versioning.html", # Provided by sphinx-multiversion
36-
"globaltoc.html",
37-
"relations.html",
38-
"sourcelink.html",
39-
"searchbox.html",
40-
]
41-
}

pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ requires-python = ">=3.10"
2727
[project.optional-dependencies]
2828
docs = [
2929
"sphinx",
30-
"sphinx_rtd_theme",
31-
"sphinx-multiversion"
30+
"sphinx_rtd_theme"
3231
]
3332

3433
[optional-dependencies]

0 commit comments

Comments
 (0)