Bump sphinx from 8.0.2 to 9.1.0 in /docs

[dependabot]

Bumps sphinx from 8.0.2 to 9.1.0.

Release notes

Sourced from sphinx's releases.

Sphinx 9.1.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Dependencies

• #14153: Drop Python 3.11 support.
• #12555: Drop Docutils 0.20 support. Patch by Adam Turner

Features added

• Add add_static_dir() for copying static assets from extensions to the build output. Patch by Jared Dillard

Bugs fixed

• #14189: autodoc: Fix duplicate :no-index-entry: for modules. Patch by Adam Turner
• #13713: Fix compatibility with MyST-Parser. Patch by Adam Turner
• Fix tests for Python 3.15. Patch by Adam Turner
• #14089: autodoc: Fix default option parsing. Patch by Adam Turner
• Remove incorrect static typing assertions. Patch by Adam Turner
• #14050: LaTeXTranslator fails to build documents using the "acronym" standard role. Patch by Günter Milde
• LaTeX: Fix rendering for grid filled merged vertical cell. Patch by Tim Nordell
• #14228: LaTeX: Fix overrun footer for cases of merged vertical table cells. Patch by Tim Nordell
• #14207: Fix creating HTMLThemeFactory objects in third-party extensions. Patch by Adam Turner
• #3099: LaTeX: PDF build crashes if a code-block contains more than circa 1350 codelines (about 27 a4-sized pages at default pointsize). Patch by Jean-François B.
• #14064: LaTeX: TABs ending up in sphinxVerbatim fail to obey tab stops. Patch by Jean-François B.
• #14089: autodoc: Improve support for non-weakreferencable objects. Patch by Adam Turner
• LaTeX: Fix accidental removal at 3.5.0 (#8854) of the documentation of literalblockcappos key of sphinxsetup. Patch by Jean-François B.

... (truncated)

Changelog

Sourced from sphinx's changelog.

Release 9.1.0 (released Dec 31, 2025)

Dependencies

• #14153: Drop Python 3.11 support.
• #12555: Drop Docutils 0.20 support. Patch by Adam Turner

Features added

• Add :meth:~sphinx.application.Sphinx.add_static_dir for copying static assets from extensions to the build output. Patch by Jared Dillard

Bugs fixed

• #14189: autodoc: Fix duplicate :no-index-entry: for modules. Patch by Adam Turner
• #13713: Fix compatibility with MyST-Parser. Patch by Adam Turner
• Fix tests for Python 3.15. Patch by Adam Turner
• #14089: autodoc: Fix default option parsing. Patch by Adam Turner
• Remove incorrect static typing assertions. Patch by Adam Turner
• #14050: LaTeXTranslator fails to build documents using the "acronym" standard role. Patch by Günter Milde
• LaTeX: Fix rendering for grid filled merged vertical cell. Patch by Tim Nordell
• #14228: LaTeX: Fix overrun footer for cases of merged vertical table cells. Patch by Tim Nordell
• #14207: Fix creating HTMLThemeFactory objects in third-party extensions. Patch by Adam Turner
• #3099: LaTeX: PDF build crashes if a code-block contains more than circa 1350 codelines (about 27 a4-sized pages at default pointsize). Patch by Jean-François B.
• #14064: LaTeX: TABs ending up in sphinxVerbatim fail to obey tab stops. Patch by Jean-François B.
• #14089: autodoc: Improve support for non-weakreferencable objects. Patch by Adam Turner
• LaTeX: Fix accidental removal at 3.5.0 (#8854) of the documentation of literalblockcappos key of :ref:'sphinxsetup' <latexsphinxsetup>. Patch by Jean-François B.

Commits

• cc7c6f4 Bump to 9.1.0 final
• b127b94 Add app.add_static_dir() for copying extension static files (#14219)
• 20f1c46 LaTeX: Inhibit breaks for rows with merged vertical cells (#14227)
• 3c85411 Polish CHANGES.rst (#14225)
• 9ee5446 LaTeX: restore 1.7 documentation of literalblockcappos (#14224)
• d75d602 LaTeX: improve (again...) some code comments in time for 9.1.0 (#14222)
• 8dca61d Improve some LaTeX code comments (#14220)
• 8ab9600 Bump to 9.1.0 candidate 2
• d59b237 autodoc: Improve support for non-weakreferencable objects
• 964424b Use the correct reference for using existing extensions (#14157)
• Additional commits viewable in compare view

You can trigger a rebase of this PR by commenting @dependabot rebase.

---

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Note
Automatic rebases have been disabled on this pull request as it has been open for over 30 days.

[RCheesley]

We need to merge #302 before this one will pass.

[adiati98]

@RCheesley, #302 has been merged. However, all checks have failed here.

[RCheesley]

Looking at the output from the job:

python -m pip install --exists-action=w --no-cache-dir -r docs/requirements.txt
ERROR: Ignored the following yanked versions: 8.3.0
ERROR: Ignored the following versions that require a different python version: 9.1.0 Requires-Python >=3.12; 9.1.0rc1 Requires-Python >=3.12; 9.1.0rc2 Requires-Python >=3.12
ERROR: Could not find a version that satisfies the requirement sphinx==9.1.0 (from versions: 0.1.61611, 0.1.61798, 0.1.61843, 0.1.61945, 0.1.61950, 0.2, 0.3, 0.4, 0.4.1, 0.4.2, 0.4.3, 0.5, 0.5.1, 0.5.2b1, 0.5.2, 0.6b1, 0.6, 0.6.1, 0.6.2, 0.6.3, 0.6.4, 0.6.5, 0.6.6, 0.6.7, 1.0b1, 1.0b2, 1.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4, 1.0.5, 1.0.6, 1.0.7, 1.0.8, 1.1, 1.1.1, 1.1.2, 1.1.3, 1.2b1, 1.2b2, 1.2b3, 1.2, 1.2.1, 1.2.2, 1.2.3, 1.3b1, 1.3b2, 1.3b3, 1.3, 1.3.1, 1.3.2, 1.3.3, 1.3.4, 1.3.5, 1.3.6, 1.4a1, 1.4b1, 1.4, 1.4.1, 1.4.2, 1.4.3, 1.4.4, 1.4.5, 1.4.6, 1.4.7, 1.4.8, 1.4.9, 1.5a1, 1.5a2, 1.5b1, 1.5, 1.5.1, 1.5.2, 1.5.3, 1.5.4, 1.5.5, 1.5.6, 1.6b1, 1.6b2, 1.6b3, 1.6.1, 1.6.2, 1.6.3, 1.6.4, 1.6.5, 1.6.6, 1.6.7, 1.7.0b1, 1.7.0b2, 1.7.0, 1.7.1, 1.7.2, 1.7.3, 1.7.4, 1.7.5, 1.7.6, 1.7.7, 1.7.8, 1.7.9, 1.8.0b1, 1.8.0, 1.8.1, 1.8.2, 1.8.3, 1.8.4, 1.8.5, 1.8.6, 2.0.0b1, 2.0.0b2, 2.0.0, 2.0.1, 2.1.0, 2.1.1, 2.1.2, 2.2.0, 2.2.1, 2.2.2, 2.3.0, 2.3.1, 2.4.0, 2.4.1, 2.4.2, 2.4.3, 2.4.4, 2.4.5, 3.0.0b1, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.0.4, 3.1.0, 3.1.1, 3.1.2, 3.2.0, 3.2.1, 3.3.0, 3.3.1, 3.4.0, 3.4.1, 3.4.2, 3.4.3, 3.5.0, 3.5.1, 3.5.2, 3.5.3, 3.5.4, 4.0.0b1, 4.0.0b2, 4.0.0, 4.0.1, 4.0.2, 4.0.3, 4.1.0, 4.1.1, 4.1.2, 4.2.0, 4.3.0, 4.3.1, 4.3.2, 4.4.0, 4.5.0, 5.0.0b1, 5.0.0, 5.0.1, 5.0.2, 5.1.0, 5.1.1, 5.2.0, 5.2.0.post0, 5.2.1, 5.2.2, 5.2.3, 5.3.0, 6.0.0b1, 6.0.0b2, 6.0.0, 6.0.1, 6.1.0, 6.1.1, 6.1.2, 6.1.3, 6.2.0, 6.2.1, 7.0.0rc1, 7.0.0, 7.0.1, 7.1.0, 7.1.1, 7.1.2, 7.2.0, 7.2.1, 7.2.2, 7.2.3, 7.2.4, 7.2.5, 7.2.6, 7.3.0, 7.3.1, 7.3.2, 7.3.3, 7.3.4, 7.3.5, 7.3.6, 7.3.7, 7.4.0, 7.4.1, 7.4.2, 7.4.3, 7.4.4, 7.4.5, 7.4.6, 7.4.7, 8.0.0rc1, 8.0.0, 8.0.1, 8.0.2, 8.1.0, 8.1.1, 8.1.2, 8.1.3, 8.2.0rc1, 8.2.0rc2, 8.2.0, 8.2.1, 8.2.2, 8.2.3, 9.0.0rc1, 9.0.0rc2, 9.0.0rc3, 9.0.0rc4, 9.0.0, 9.0.1, 9.0.2, 9.0.3, 9.0.4)
ERROR: No matching distribution found for sphinx==9.1.0

It looks like we need to bump the Python version first:

• Sphinx Version Requirement: The build is trying to use Sphinx version 9.1.0, which requires Python 3.12. However, the environment is using Python 3.11.

• Python Version: The Python version specified in your configuration is 3.11. You either need to update your Python version to meet the higher requirement for Sphinx 9.1.0, or adjust the Sphinx version to one compatible with Python 3.11.

• Read the Docs YAML Configuration: Ensure that your ⁠.readthedocs.yaml specifies a compatible Sphinx version under ⁠python requirements if needed, or update the Python version if your documentation requires features from the latest Sphinx release.

To resolve this issue, you can update the ⁠requirements.txt or ⁠.readthedocs.yaml file to specify a compatible version of Sphinx or adjust your Python version to meet the requirements

[RCheesley]

#304 should be sufficient.

[RCheesley]

@dependabot rebase

[dependabot]

Looks like this PR is already up-to-date with 5.x! If you'd still like to recreate it from scratch, overwriting any edits, you can request @dependabot recreate.

[dependabot]

OK, I won't notify you again about this release, but will get in touch when a new version is available. If you'd rather skip all updates until the next major or minor version, let me know by commenting @dependabot ignore this major version or @dependabot ignore this minor version. You can also ignore all major, minor, or patch releases for a dependency by adding an ignore condition with the desired update_types to your config file.

If you change your mind, just re-open this PR and I'll resolve any conflicts on it.

[RCheesley]

Looks like we have a few more dependencies to bump before we can merge this one:

esbonio 0.16.5 depends on sphinx
sphinxcontrib-phpdomain 0.13.2 depends on sphinx<9.0 and >=1.3

Esbonio in particular seems to be very out of date! 😱

I can't see a release for sphinxcontrib-phpdomain: https://github.com/markstory/sphinxcontrib-phpdomain/releases and I'm not sure if they're already working on it, raised an issue here: markstory/sphinxcontrib-phpdomain#79.