Skip to content

Conversation

@Satellite-QE
Copy link
Collaborator

Cherrypick of PR: #20578

Bumps sphinx from 9.0.4 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

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually 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 merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @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)

@Satellite-QE Satellite-QE added 6.18.z Introduced in or relating directly to Satellite 6.18 Auto_Cherry_Picked Automatically cherrypicked PR using GHA dependencies Pull requests that update a dependency file No-CherryPick PR doesnt need CherryPick to previous branches labels Jan 1, 2026
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • Since Sphinx 9.1.0 drops Python 3.11 and Docutils 0.20 support, double-check that the 6.18.z branch’s runtime/build environment (Python and docutils versions) is compatible with these new constraints to avoid breaking docs builds.
  • Given the changes around HTMLThemeFactory and new add_static_dir() behavior in Sphinx 9.1.0, verify that any custom Sphinx extensions or theme hooks in this repo don’t rely on the previous HTML theme initialization or static asset handling APIs.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Since Sphinx 9.1.0 drops Python 3.11 and Docutils 0.20 support, double-check that the 6.18.z branch’s runtime/build environment (Python and docutils versions) is compatible with these new constraints to avoid breaking docs builds.
- Given the changes around HTMLThemeFactory and new add_static_dir() behavior in Sphinx 9.1.0, verify that any custom Sphinx extensions or theme hooks in this repo don’t rely on the previous HTML theme initialization or static asset handling APIs.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@github-actions github-actions bot merged commit beeef09 into 6.18.z Jan 1, 2026
24 checks passed
@github-actions github-actions bot deleted the cherry-pick-6.18.z-b71abc4c7c7a16791dcad17e74f45b9207da1b3e branch January 1, 2026 03:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

6.18.z Introduced in or relating directly to Satellite 6.18 Auto_Cherry_Picked Automatically cherrypicked PR using GHA dependencies Pull requests that update a dependency file No-CherryPick PR doesnt need CherryPick to previous branches

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants