Skip to content

Commit 78e765b

Browse files
Pins sphinx<9 to fix sphinx-multiversion compatibility (#5211)
## Description Sphinx 9.0 changed `Config.read()` to use keyword-only parameters (`overrides` and `tags`), breaking `sphinx-multiversion==0.2.4` which passes arguments positionally. This causes the multi-version docs CI build to fail with: ``` TypeError: Config.read() takes 2 positional arguments but 3 were given ``` The `develop` branch has `sphinx>=7.0` with no upper bound, so CI (Python 3.12) resolves to Sphinx 9.1.0 which introduced the breaking API change. ## Fix Pin `sphinx>=7.0,<9` in `docs/requirements.txt` to keep Sphinx on the 8.x line until `sphinx-multiversion` is updated or replaced with a maintained fork. ## Type of change - [x] Bug fix (non-breaking change which fixes an issue) Co-authored-by: Kelly Guo <kellyguo11@users.noreply.github.com> Co-authored-by: Antoine RICHARD <antoiner@nvidia.com>
1 parent a62f5a1 commit 78e765b

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

docs/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# for building the docs
2-
sphinx>=7.0
2+
sphinx>=7.0,<9
33
sphinx-book-theme>=1.1
44
myst-parser
55
sphinxcontrib-bibtex==2.5.0

0 commit comments

Comments
 (0)