Skip to content

Pin the docs extensions that Sphinx 9 broke - #810

Merged
cvanelteren merged 2 commits into
mainfrom
docs/sphinx9-extension-floors
Sep 2, 2026
Merged

Pin the docs extensions that Sphinx 9 broke#810
cvanelteren merged 2 commits into
mainfrom
docs/sphinx9-extension-floors

Conversation

@cvanelteren

Copy link
Copy Markdown
Collaborator

Sphinx 9 removed sphinx.ext.autosummary.get_documenter. sphinx-automodapi 0.19 imports it at module level, so a docs build against Sphinx 9 dies before it starts:

Extension error (sphinx_automodapi.automodsumm)!
cannot import name 'get_documenter' from 'sphinx.ext.autosummary'

sphinx-design 0.6.1 and nbsphinx 0.9.7 also declare upper bounds that exclude Sphinx 9. The docs extra listed all three unconstrained, so pip install .[docs] was free to produce a combination that cannot build.

Floors are the versions verified to build the docs against Sphinx 9.1.0 on Python 3.14: nbsphinx 0.9.8, sphinx-automodapi 0.22, sphinx-design 0.7.

Sphinx 9 removed `sphinx.ext.autosummary.get_documenter`. sphinx-automodapi
0.19 imports it at module level, so a docs build against Sphinx 9 dies before
it starts:

    Extension error (sphinx_automodapi.automodsumm)!
    cannot import name 'get_documenter' from 'sphinx.ext.autosummary'

sphinx-design 0.6.1 and nbsphinx 0.9.7 also declare upper bounds that exclude
Sphinx 9. The docs extra listed all three unconstrained, so `pip install
.[docs]` was free to produce a combination that cannot build.

Floors are the versions verified to build the docs against Sphinx 9.1.0 on
Python 3.14: nbsphinx 0.9.8, sphinx-automodapi 0.22, sphinx-design 0.7.
@codecov

codecov Bot commented Sep 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@cvanelteren
cvanelteren merged commit 215ddad into main Sep 2, 2026
18 of 19 checks passed
@cvanelteren
cvanelteren deleted the docs/sphinx9-extension-floors branch September 2, 2026 00:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant