Update dependency sphinx to v9 #80

renovate · 2025-12-01T11:50:48Z

This PR contains the following updates:

Package	Change	Age	Confidence
sphinx (changelog)	`>=8,<9` → `>=9,<10`

Release Notes

sphinx-doc/sphinx (sphinx)

`v9.1.0`

Compare Source

==============================

Dependencies

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

Incompatible changes

Deprecated

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.

Testing

`v9.0.4`: Sphinx 9.0.4

Compare Source

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

Bugs fixed

#14143: Fix spurious build warnings when translators reorder references
in strings, or use translated display text in references.
Patch by Matt Wang.

`v9.0.3`: Sphinx 9.0.3

Compare Source

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

Bugs fixed

#14142: autodoc: Restore some missing exports in sphinx.ext.autodoc.
Patch by Adam Turner.

`v9.0.2`: Sphinx 9.0.2

Compare Source

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

Bugs fixed

#14142: autodoc: Restore sphinx.ext.autodoc.mock.
Patch by Adam Turner.

`v9.0.1`: Sphinx 9.0.1

Compare Source

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

Bugs fixed

#13942: autodoc: Restore the mapping interface for options objects.
Patch by Adam Turner.
#13942: autodoc: Deprecate the mapping interface for options objects.
Patch by Adam Turner.
#13387: Update translations.

`v9.0.0`: Sphinx 9.0.0

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

Dependencies

#13786: Support Docutils 0.22. Patch by Adam Turner.

Incompatible changes

#13639: SphinxComponentRegistry.create_source_parser no longer
has an app parameter, instead taking config and env.
Patch by Adam Turner.
#13679: Non-decodable characters in source files now raise an error.
Such bytes have been replaced with '?' along with logging a warning
since Sphinx 2.0.
Patch by Adam Turner.
#13751, #14089: sphinx.ext.autodoc has been substantially rewritten,
and there may be some incompatible changes in edge cases, especially when
extensions interact with autodoc internals.
The autodoc_use_legacy_class_based option has been added to
use the legacy (pre-9.0) implementation of autodoc.
Patches by Adam Turner.
#13355: Don't include escaped title content in the search index.
Patch by Will Lachance.

Deprecated

13627: Deprecate remaining public app attributes,
including builder.app, env.app, events.app,
and SphinxTransform.app.
Patch by Adam Turner.
#13637: Deprecate the set_application method
of Parser objects.
Patch by Adam Turner.
#13644: Deprecate the Parser.config and env attributes.
Patch by Adam Turner.
#13665: Deprecate support for non-UTF 8 source encodings,
scheduled for removal in Sphinx 10.
Patch by Adam Turner.
#13682: Deprecate sphinx.io.
Sphinx no longer uses the sphinx.io classes,
having replaced them with standard Python I/O.
The entire sphinx.io module will be removed in Sphinx 10.
Patch by Adam Turner.
#13631: sphinx.environment.adapters.toctree.global_toctree_for_doc
and sphinx.environment.BuildEnvironment.get_and_resolve_doctree
will require a tags keyword argument from Sphinx 11.
It may optionally be passed from Sphinx 9 onwards.
Patch by Adam Turner.

Features added

#13332: Add doctest_fail_fast option to exit after the first failed
test.
Patch by Till Hoffmann.
#13439: linkcheck: Permit warning on every redirect with
linkcheck_allowed_redirects = {}.
Patch by Adam Turner and James Addison.
#13497: Support C domain objects in the table of contents.
#13500: LaTeX: add support for fontawesome6 package.
Patch by Jean-François B.
#13509: autodoc: Detect typing_extensions.overload
and final decorators.
Patch by Spencer Brown.
#13535: html search: Update to the latest version of Snowball (v3.0.1).
Patch by Adam Turner.
#13647: LaTeX: allow more cases of table nesting.
Patch by Jean-François B.
#13657: LaTeX: support CSS3 length units.
Patch by Jean-François B.
#13684: intersphinx: Add a file-based cache for remote inventories.
The location of the cache directory must not be relied upon externally,
as it may change without notice or warning in future releases.
Patch by Adam Turner.
#13805: LaTeX: add support for fontawesome7 package.
Patch by Jean-François B.
#13508: autodoc: Initial support for PEP 695 type aliases.
Patch by Martin Matouš, Jeremy Maitin-Shepard, and Adam Turner.
#14023: Add the new mathjax_config_path option
to load MathJax configuration from a file.
Patch by Randolf Scholz and Adam Turner.
#14046: linkcheck: Add the linkcheck_case_insensitive_urls option
to allow case-insensitive URL comparison for specific URL patterns.
This is useful for links to websites that normalise URL casing (e.g. GitHub)
or case-insensitive servers.
Patch by Fazeel Usmani and James Addison.
#14075: autosummary: Provide more context in import exception stack traces.
Patch by Philipp A.
#13468: Add config options to sphinx.ext.duration.
Patch by Erik Bedard and Adam Turner.
#14022: Use MathJax v4 by default in the sphinx.ext.mathjax extension,
from v3 previously.
To keep using an older version, set the mathjax_path option.
Also add the new mathjax4_config option to configure MathJax v4.
Note that MathJax v3 is mostly compatible with MathJax v4, so existing
mathjax3_config settings should not need to change.
Patch by Matthias Geier.
#14029: intersphinx: Fix error in format string interpolation.
Patch by Matthieu de Cibeins.

Bugs fixed

#13926: multiple py:type directives for the same canonical type no
longer result in spurious duplicate object description warnings.
Patch by Jeremy Maitin-Shepard.
#1327: LaTeX: tables using longtable raise error if
tabularcolumns specifies automatic widths
(L, R, C, or J).
Patch by Jean-François B.
#3447: LaTeX: when assigning longtable class to table for PDF, it may render
"horizontally" and overflow in right margin.
Patch by Jean-François B.
#8828: LaTeX: adding a footnote to a longtable cell causes table to occupy
full width.
Patch by Jean-François B.
#11498: LaTeX: Table in cell fails to build if it has many rows.
Patch by Jean-François B.
#11515: LaTeX: longtable does not allow nested table.
Patch by Jean-François B.
#11973: LaTeX: links in table captions do not work in PDF.
Patch by Jean-François B.
#12821: LaTeX: URLs/links in section titles should render in PDF.
Patch by Jean-François B.
#13369: Correctly parse and cross-reference unpacked type annotations.
Patch by Alicia Garcia-Raboso.
#13528: Add tilde ~ prefix support for py:deco.
Patch by Shengyu Zhang and Adam Turner.
#13597: LaTeX: table nested in a merged cell leads to invalid LaTeX mark-up
and PDF cannot be built.
Patch by Jean-François B.
#13619: LaTeX: possible duplicated footnotes in PDF from object signatures
(typically if latex_show_urls = 'footnote').
Patch by Jean-François B.
#13635: LaTeX: if a cell contains a table, row coloring is turned off for
the next table cells.
Patch by Jean-François B.
#13685: gettext: Correctly ignore trailing backslashes.
Patch by Bénédikt Tran.
#13712: intersphinx: Don't add "v" prefix to non-numeric versions.
Patch by Szymon Karpinski.
#13688: HTML builder: Replace <em class="property"> with
<span class="property"> for attribute type annotations
to improve semantic HTML structure.
Patch by Mark Ostroth.
#13812 (discussion): LaTeX: long confval value does not wrap at
spaces in PDF.
Patch by Jean-François B.
#10785: Autodoc: Allow type aliases defined in the project to be properly
cross-referenced when used as type annotations. This makes it possible
for objects documented as :py:data: to be hyperlinked in function signatures.
#13858: doctest: doctest blocks are now correctly added to a group defined by the
configuration variable doctest_test_doctest_blocks.
#13885: Coverage builder: Fix TypeError when warning about missing modules.
Patch by Damien Ayers.
#13929: Duplicate equation label warnings now have a new warning
sub-type, ref.equation.
Patch by Jared Dillard.
#13935: autoclass: parent class members no longer considered
directly defined in certain cases, depending on autodoc processing
order.
Patch by Jeremy Maitin-Shepard.
#13939: LaTeX: page break can separate admonition title from contents.
Patch by Jean-François B.
#14004: Fix autodoc_type_aliases when they appear in PEP 604
union syntax (Alias | Type).
Patch by Tamika Nomara.
#14059: LaTeX: Footnotes cause pdflatex error with French language
(since late June 2025 upstream change to LaTeX babel-french).
Patch by Jean-François B.
#13916: HTML Search: do not clear text fragments from the URL on page load.
Patch by Harmen Stoppels.
#13944: autodoc: show traceback during import in human readable representation.
Patch by Florian Best.
#14006: Support images with data URIs that aren't base64-encoded.
Patch by Shengyu Zhang and Adam Turner.
#12797: Fix Some type variables (...) are not listed in Generic[...]
TypeError when inheriting from both Generic and autodoc mocked class.
Patch by Ikor Jefocur and Daniel Sperber.
#13945: autodoc: Fix handling of undefined names in annotations by using
the FORWARDREF annotationlib format.
Patch by Rui Pinheiro and Adam Turner.
#14067: EPUB: unify path separators in manifest items to forward slashes;
resolve duplicates in the manifest on Windows.
Patch by Akihiro Takizawa.
#13741: text builder: fix an infinite loop when processing CSV tables.
Patch by Bénédikt Tran.
#13217: Remove extra parentheses from js:function arguments and errors.
Patch by Shengyu Zhang.

Dependencies

#13000: Drop Python 3.10 support.

Incompatible changes

#13044: Remove the internal and undocumented has_equations data
from the MathDomain domain.
The undocumented MathDomain.has_equations method
now unconditionally returns True.
These are replaced by the has_maths_elements key of the page context dict.
Patch by Adam Turner.
#13227: HTML output for sequences of keys in the kbd role
no longer uses a <kbd class="kbd compound"> element to wrap
the keys and separators, but places them directly in the relevant parent node.
This means that CSS rulesets targeting kbd.compound or .kbd.compound
will no longer have any effect.
Patch by Adam Turner.

Deprecated

#13037: Deprecate the SingleHTMLBuilder.fix_refuris method.
Patch by James Addison.
#13083, #13330: Un-deprecate sphinx.util.import_object.
Patch by Matthias Geier.

Features added

#13173: Add a new duplicate_declaration warning type,
with duplicate_declaration.c and duplicate_declaration.cpp subtypes.
Patch by Julien Lecomte and Adam Turner.
#11824: linkcode: Allow extensions to add support for a domain by defining
the keys that should be present.
Patch by Nicolas Peugnet.
#13144: Add a class option to the autosummary directive.
Patch by Tim Hoffmann.
#13146: Napoleon: Unify the type preprocessing logic to allow
Google-style docstrings to use the optional and default keywords.
Patch by Chris Barrick.
#13227: Implement the kbd role as a SphinxRole.
Patch by Adam Turner.
#13065: Enable colour by default in when running on CI.
Patch by Adam Turner.
#13230: Allow supressing warnings from the toctree directive
when a glob pattern doesn't match any documents,
via the new toc.empty_glob warning sub-type.
Patch by Slawek Figiel.
#9732: Add the new autodoc.mocked_object warnings sub-type.
Patch by Cyril Roelandt.
#7630, #4824: autodoc: Use .pyi type stub files
to auto-document native modules.
Patch by Adam Turner, partially based on work by Allie Fitter.
#12975: Enable configuration of trailing commas in multi-line signatures
in the Python and Javascript domains, via the new
python_trailing_comma_in_multi_line_signatures and
javascript_trailing_comma_in_multi_line_signatures
configuration options.
#13264: Rename the math directive's nowrap option
to no-wrap.
Patch by Adam Turner.
#13269: Added the option to disable the use of type comments in
via the new autodoc_use_type_comments option,
which defaults to True for backwards compatibility.
The default will change to False in Sphinx 10.
Patch by Adam Turner.
#9732: Add the new ref.any warnings sub-type
to allow suppressing the ambiguous 'any' cross-reference warning.
Patch by Simão Afonso and Adam Turner.
#13272: The Python and JavaScript module directives now support
the :no-index-entry: option.
Patch by Adam Turner.
#12233: autodoc: Allow directives to use :no-index-entry:
and include the :no-index: and :no-index-entry: options within
autodoc_default_options.
Patch by Jonny Saunders and Adam Turner.
#13172: Add support for short signatures in autosummary.
Patch by Tim Hoffmann.
#13271: Change the signature prefix for abstract methods
in the Python domain to abstractmethod from abstract.
Patch by Adam Turner.
#13271: Support the :abstract: option for
classes, methods, and properties in the Python domain.
Patch by Adam Turner.
#12507: Add the collapsible <collapsible-admonitions> option
to admonition directives.
Patch by Chris Sewell.
#8191, #8159: Add include-subclasses option to
the inheritance-diagram directive.
Patch by Walter Dörwald.
#11995: autodoc: Add support for python_display_short_literal_types.
Patch by Bénédikt Tran and Adam Turner.
#13163: Always print the full context when Sphinx encounters an internal error.
Patch by Kevin Deldycke and Adam Turner.
#13105: Introduce the py:deco role to cross-reference decorator
functions and methods in the Python domain.
Patch by Adam Turner.
#9169: Add the intersphinx_resolve_self option
to resolve an intersphinx reference to the current project.
Patch by Jakob Lykke Andersen and Adam Turner.
#11280: Add ability to skip a particular section using the no-search class.
Patch by Will Lachance.
#13326: Remove hardcoding from handling productionlist
nodes in all writers, to improve flexibility.
Patch by Adam Turner.
#13335: Use misc.highlighting_failure subtype for Pygments unknown lexers.
Patch by Bart Kamphorst.
#13354: Insert abbreviation nodes (hover text) for positional- and keyword-only
separators in Python signatures.
Patch by Adam Turner.
#13333: Add the sphinx.ext.apidoc extension,
to automate API documentation generation from Python modules.
Patch by Chris Sewell and Adam Turner.

Bugs fixed

#12463: autosummary: Respect an empty module __all__.
Patch by Valentin Pratz
#13060: HTML Search: use Map to store per-file term scores.
Patch by James Addison
#13130: LaTeX docs: pdflatex index creation may fail for index entries
in French. See latex_use_xindy.
Patch by Jean-François B.
#13152: LaTeX: fix a typo from v7.4.0 in a default for \sphinxboxsetup.
Patch by Jean-François B.
#13096: HTML Search: check that query terms exist as properties in
term indices before accessing them.
#11233: linkcheck: match redirect URIs against linkcheck_ignore by
overriding session-level requests.get_redirect_target.
#13195: viewcode: Fix issue where import paths differ from the directory
structure.
Patch by Ben Egan and Adam Turner.
#13188: autodoc: fix detection of class methods implemented in C.
Patch by Bénédikt Tran.
#1810: Always copy static files when building, regardless of whether
any documents have changed since the previous build.
Patch by Adam Turner.
#13201: autodoc: fix ordering of members when using groupwise
for autodoc_member_order. Class methods are now rendered
before static methods, which themselves are rendered before regular
methods and attributes.
Patch by Bénédikt Tran.
#12975: Avoid rendering a trailing comma in C and C++ multi-line signatures.
#13178: autodoc: Fix resolution for pathlib types.
Patch by Adam Turner.
#13136: autodoc: Correctly handle multiple inheritance.
Patch by Pavel Holica
#13273, #13318: Properly convert command-line overrides for Boolean types.
Patch by Adam Turner.
#13302, #13319: Use the correct indentation for continuation lines
in productionlist directives.
Patch by Adam Turner.
#13328: Fix parsing of PEP 695 functions with return annotations.
Patch by Bénédikt Tran. Initial work by Arash Badie-Modiri.

Testing

#13224: Correctness fixup for test_html_multi_line_copyright.
Patch by Colin Watson, applied by James Addison.

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

renovate · 2025-12-01T11:50:49Z

⚠️ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

any of the package files in this branch needs updating, or
the branch becomes conflicted, or
you click the rebase/retry checkbox if found above, or
you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: uv.lock

Command failed: uv lock --upgrade-package sphinx --upgrade-package sphinx
warning: The `requires-python` specifier (`~=3.11`) in `phx-class-registry` uses the tilde specifier (`~=`) without a patch version. This will be interpreted as `>=3.11, <4`. Did you mean `~=3.11.0` to constrain the version as `>=3.11.0, <3.12`? We recommend only using the tilde specifier with a patch version to avoid ambiguity.
Using CPython 3.11.14 interpreter at: /opt/containerbase/tools/python/3.11.14/bin/python3
  × No solution found when resolving dependencies for split (markers:
  │ python_full_version >= '3.12' and python_full_version < '4'):
  ╰─▶ Because sphinx-rtd-theme>=3.0.0 depends on sphinx>=6,<9 and only the
      following versions of sphinx-rtd-theme are available:
          sphinx-rtd-theme<=3.0.0
          sphinx-rtd-theme==3.0.1
          sphinx-rtd-theme==3.0.2
      we can conclude that sphinx-rtd-theme>=3.0.0 depends on sphinx>=6,<9.
      And because phx-class-registry:ci depends on sphinx>=9, we can conclude
      that phx-class-registry:ci and sphinx-rtd-theme>=3.0.0 are incompatible.
      And because phx-class-registry:ci depends on sphinx-rtd-theme>=3 and
      your project requires phx-class-registry:ci, we can conclude that your
      project's requirements are unsatisfiable.

      hint: Pre-releases are available for `sphinx-rtd-theme` in the
      requested range (e.g., 3.1.0rc1), but pre-releases weren't enabled (try:
      `--prerelease=allow`)

      hint: While the active Python version is 3.11, the resolution failed for
      other Python versions supported by your project. Consider limiting your
      project's supported Python versions using `requires-python`.

Update dependency sphinx to v9

6e513fb

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update dependency sphinx to v9 #80

Update dependency sphinx to v9 #80

Uh oh!

renovate bot commented Dec 1, 2025 •

edited

Loading

Uh oh!

renovate bot commented Dec 1, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Update dependency sphinx to v9 #80

Are you sure you want to change the base?

Update dependency sphinx to v9 #80

Uh oh!

Conversation

renovate bot commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Release Notes

v9.1.0

Dependencies

Incompatible changes

Deprecated

Features added

Bugs fixed

Testing

v9.0.4: Sphinx 9.0.4

Bugs fixed

v9.0.3: Sphinx 9.0.3

Bugs fixed

v9.0.2: Sphinx 9.0.2

Bugs fixed

v9.0.1: Sphinx 9.0.1

Bugs fixed

v9.0.0: Sphinx 9.0.0

Dependencies

Incompatible changes

Deprecated

Features added

Bugs fixed

v8.2.3: Sphinx 8.2.3

v8.2.2: Sphinx 8.2.2

v8.2.1: Sphinx 8.2.1

v8.2.0: Sphinx 8.2.0

Dependencies

Incompatible changes

Deprecated

Features added

Bugs fixed

Testing

Configuration

Uh oh!

renovate bot commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ Artifact update problem

File name: uv.lock

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

renovate bot commented Dec 1, 2025 •

edited

Loading

`v9.1.0`

`v9.0.4`: Sphinx 9.0.4

`v9.0.3`: Sphinx 9.0.3

`v9.0.2`: Sphinx 9.0.2

`v9.0.1`: Sphinx 9.0.1

`v9.0.0`: Sphinx 9.0.0

`v8.2.3`: Sphinx 8.2.3

`v8.2.2`: Sphinx 8.2.2

`v8.2.1`: Sphinx 8.2.1

`v8.2.0`: Sphinx 8.2.0

renovate bot commented Dec 1, 2025 •

edited

Loading