Skip to content

Commit 2581ac3

Browse files
committed
Pin Sphinx to 8.x to fix documentation build.
Our custom Sphinx extension `myst_docstring`, which lets us write doc-strings in Markdown instead of reStructuredText, is not compatible with Sphinx 9, for which the Autodoc extension "has been substantially rewritten, and there may be some incompatible changes in edge cases, especially when extensions interact with autodoc internals." See the release notes: https://www.sphinx-doc.org/en/master/changes/9.0.html#release-9-0-0-released-nov-30-2025 That's exactly what our extension does though. The mitigation recommended in the release notes, to set `autodoc_use_legacy_class_based = True` in `conf.py` does not seem to help.
1 parent 90d80d8 commit 2581ac3

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ test = [
3636
'codecov >= 2',
3737
]
3838
docs = [
39-
'Sphinx >= 8',
39+
'Sphinx >= 8, < 9',
4040
'MyST-parser >= 1',
4141
'Furo >= 2024',
4242
]

0 commit comments

Comments
 (0)