chore(deps): update dependency sphinx to v9 #73
+1
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
renovate
bot
added
the
🤖 dependencies
renovate
bot
force-pushed
the
renovate/sphinx-9.x
branch
from
6760073 to
dbd2e42
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
==7.4.7->==9.0.1Release Notes
sphinx-doc/sphinx (Sphinx)
v9.0.1Compare Source
=====================================
Bugs fixed
Patch by Adam Turner.
Patch by Adam Turner.
v9.0.0=====================================
Dependencies
#13786: Support
Docutils 0.22_. Patch by Adam Turner... _Docutils 0.22: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-22-2026-07-29
Incompatible changes
!SphinxComponentRegistry.create_source_parserno longerhas an app parameter, instead taking config and env.
Patch by Adam Turner.
Such bytes have been replaced with '?' along with logging a warning
since Sphinx 2.0.
Patch by Adam Turner.
sphinx.ext.autodochas been substantially rewritten,and there may be some incompatible changes in edge cases, especially when
extensions interact with autodoc internals.
The :confval:
autodoc_use_legacy_class_basedoption has been added touse the legacy (pre-9.0) implementation of autodoc.
Patches by Adam Turner.
Patch by Will Lachance.
Deprecated
!.appattributes,including
builder.app,env.app,events.app,and
SphinxTransform.app.Patch by Adam Turner.
!set_applicationmethodof :py:class:
~sphinx.parsers.Parserobjects.Patch by Adam Turner.
!Parser.configand :py:attr:!envattributes.Patch by Adam Turner.
scheduled for removal in Sphinx 10.
Patch by Adam Turner.
!sphinx.io.Sphinx no longer uses the :py:mod:
!sphinx.ioclasses,having replaced them with standard Python I/O.
The entire :py:mod:
!sphinx.iomodule will be removed in Sphinx 10.Patch by Adam Turner.
!sphinx.environment.adapters.toctree.global_toctree_for_docand :meth:
!sphinx.environment.BuildEnvironment.get_and_resolve_doctreewill require a tags keyword argument from Sphinx 11.
It may optionally be passed from Sphinx 9 onwards.
Patch by Adam Turner.
Features added
doctest_fail_fastoption to exit after the first failedtest.
Patch by Till Hoffmann.
linkcheck_allowed_redirects = {}.Patch by Adam Turner and James Addison.
fontawesome6package.Patch by Jean-François B.
typing_extensions.overload <typing.overload>and :py:func:
~typing.finaldecorators.Patch by Spencer Brown.
Patch by Adam Turner.
Patch by Jean-François B.
Patch by Jean-François B.
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.
fontawesome7package.Patch by Jean-François B.
695type aliases.Patch by Martin Matouš, Jeremy Maitin-Shepard, and Adam Turner.
mathjax_config_pathoptionto load MathJax configuration from a file.
Patch by Randolf Scholz and Adam Turner.
linkcheck_case_insensitive_urlsoptionto 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.
Patch by Philipp A.
sphinx.ext.duration.Patch by Erik Bedard and Adam Turner.
sphinx.ext.mathjaxextension,from v3 previously.
To keep using an older version, set the :confval:
mathjax_pathoption.Also add the new :confval:
mathjax4_configoption to configure MathJax v4.Note that MathJax v3 is mostly compatible with MathJax v4, so existing
:confval:
mathjax3_configsettings should not need to change.Patch by Matthias Geier.
Patch by Matthieu de Cibeins.
source_code_parsertype to :confval:suppress_warningsfor grouping issues related to the C and C++ parsers.
Patch by Valentin H.
Bugs fixed
longer result in spurious duplicate object description warnings.
Patch by Jeremy Maitin-Shepard.
:rst:dir:
tabularcolumnsspecifies automatic widths(
L,R,C, orJ).Patch by Jean-François B.
"horizontally" and overflow in right margin.
Patch by Jean-François B.
full width.
Patch by Jean-François B.
Patch by Jean-François B.
Patch by Jean-François B.
Patch by Jean-François B.
Patch by Jean-François B.
Patch by Alicia Garcia-Raboso.
~prefix support for :rst:role:py:deco.Patch by Shengyu Zhang and Adam Turner.
and PDF cannot be built.
Patch by Jean-François B.
(typically if :confval:
latex_show_urls= 'footnote').Patch by Jean-François B.
the next table cells.
Patch by Jean-François B.
Patch by Bénédikt Tran.
Patch by Szymon Karpinski.
<em class="property">with<span class="property">for attribute type annotationsto improve
semantic HTML structure <https://html.spec.whatwg.org/multipage/text-level-semantics.html>__.Patch by Mark Ostroth.
confvalvalue does not wrap atspaces in PDF.
Patch by Jean-François B.
cross-referenced when used as type annotations. This makes it possible
for objects documented as
:py:data:to be hyperlinked in function signatures.configuration variable
doctest_test_doctest_blocks.Patch by Damien Ayers.
sub-type,
ref.equation.Patch by Jared Dillard.
directly defined in certain cases, depending on autodoc processing
order.
Patch by Jeremy Maitin-Shepard.
Patch by Jean-François B.
autodoc_type_aliaseswhen they appear in PEP 604union syntax (
Alias | Type).Patch by Tamika Nomara.
(since late June 2025 upstream change to LaTeX
babel-french).Patch by Jean-François B.
Patch by Harmen Stoppels.
Patch by Florian Best.
Patch by Shengyu Zhang and Adam Turner.
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.
the
FORWARDREF:mod:annotationlibformat.Patch by Rui Pinheiro and Adam Turner.
resolve duplicates in the manifest on Windows.
Patch by Akihiro Takizawa.
Patch by Bénédikt Tran.
js:functionarguments and errors.Patch by Shengyu Zhang.
Testing
v8.2.3: Sphinx 8.2.3Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
v8.2.2: Sphinx 8.2.2Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
v8.2.1: Sphinx 8.2.1Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
v8.2.0: Sphinx 8.2.0Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
Dependencies
Incompatible changes
has_equationsdatafrom the
MathDomaindomain.The undocumented
MathDomain.has_equationsmethodnow unconditionally returns
True.These are replaced by the
has_maths_elementskey of the page context dict.Patch by Adam Turner.
kbdroleno longer uses a
<kbd class="kbd compound">element to wrapthe keys and separators, but places them directly in the relevant parent node.
This means that CSS rulesets targeting
kbd.compoundor.kbd.compoundwill no longer have any effect.
Patch by Adam Turner.
Deprecated
SingleHTMLBuilder.fix_refurismethod.Patch by James Addison.
sphinx.util.import_object.Patch by Matthias Geier.
Features added
duplicate_declarationwarning type,with
duplicate_declaration.candduplicate_declaration.cppsubtypes.Patch by Julien Lecomte and Adam Turner.
the keys that should be present.
Patch by Nicolas Peugnet.
classoption to theautosummarydirective.Patch by Tim Hoffmann.
Google-style docstrings to use the optional and default keywords.
Patch by Chris Barrick.
kbdrole as aSphinxRole.Patch by Adam Turner.
Patch by Adam Turner.
toctreedirectivewhen a glob pattern doesn't match any documents,
via the new
toc.empty_globwarning sub-type.Patch by Slawek Figiel.
autodoc.mocked_objectwarnings sub-type.Patch by Cyril Roelandt.
.pyitype stub filesto auto-document native modules.
Patch by Adam Turner, partially based on work by Allie Fitter.
in the Python and Javascript domains, via the new
python_trailing_comma_in_multi_line_signaturesandjavascript_trailing_comma_in_multi_line_signaturesconfiguration options.
mathdirective'snowrapoptionto
no-wrap.Patch by Adam Turner.
via the new
autodoc_use_type_commentsoption,which defaults to
Truefor backwards compatibility.The default will change to
Falsein Sphinx 10.Patch by Adam Turner.
ref.anywarnings sub-typeto allow suppressing the ambiguous 'any' cross-reference warning.
Patch by Simão Afonso and Adam Turner.
the
:no-index-entry:option.Patch by Adam Turner.
:no-index-entry:and include the
:no-index:and:no-index-entry:options withinautodoc_default_options.Patch by Jonny Saunders and Adam Turner.
Patch by Tim Hoffmann.
in the Python domain to abstractmethod from abstract.
Patch by Adam Turner.
:abstract:option forclasses, methods, and properties in the Python domain.
Patch by Adam Turner.
collapsible <collapsible-admonitions>optionto admonition directives.
Patch by Chris Sewell.
include-subclassesoption tothe
inheritance-diagramdirective.Patch by Walter Dörwald.
python_display_short_literal_types.Patch by Bénédikt Tran and Adam Turner.
Patch by Kevin Deldycke and Adam Turner.
py:decorole to cross-reference decoratorfunctions and methods in the Python domain.
Patch by Adam Turner.
intersphinx_resolve_selfoptionto resolve an intersphinx reference to the current project.
Patch by Jakob Lykke Andersen and Adam Turner.
no-searchclass.Patch by Will Lachance.
productionlistnodes in all writers, to improve flexibility.
Patch by Adam Turner.
misc.highlighting_failuresubtype for Pygments unknown lexers.Patch by Bart Kamphorst.
separators in Python signatures.
Patch by Adam Turner.
sphinx.ext.apidocextension,to automate API documentation generation from Python modules.
Patch by Chris Sewell and Adam Turner.
Bugs fixed
__all__.Patch by Valentin Pratz
Mapto store per-file term scores.Patch by James Addison
pdflatexindex creation may fail for index entriesin French. See
latex_use_xindy.Patch by Jean-François B.
\sphinxboxsetup.Patch by Jean-François B.
term indices before accessing them.
linkcheck_ignorebyoverriding session-level
requests.get_redirect_target.structure.
Patch by Ben Egan and Adam Turner.
Patch by Bénédikt Tran.
any documents have changed since the previous build.
Patch by Adam Turner.
groupwisefor
autodoc_member_order. Class methods are now renderedbefore static methods, which themselves are rendered before regular
methods and attributes.
Patch by Bénédikt Tran.
pathlibtypes.Patch by Adam Turner.
Patch by Pavel Holica
Patch by Adam Turner.
in
productionlistdirectives.Patch by Adam Turner.
Patch by Bénédikt Tran. Initial work by Arash Badie-Modiri.
Testing
test_html_multi_line_copyright.Patch by Colin Watson, applied by James Addison.
v8.1.3: Sphinx 8.1.3Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html
Bugs fixed
cut_lines()with no object type. Patch by Adam Turner.v8.1.2: Sphinx 8.1.2Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html
Bugs fixed
sphinx.errors.ExtensionErrorinsphinx.utilfor backwards compatibility. This will be removed in Sphinx 9, as exposing the exception insphinx.utilwas never intentional.ExtensionErrorhas been part ofsphinx.errorssince Sphinx 0.9. Patch by Adam Turner.v8.1.1: Sphinx 8.1.1Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html
Bugs fixed
the
:cve:role.Patch by Hugo van Kemenade.
fontawesomeorfontawesome5packages are not installed.Patch by Jean-François B.
v8.1.0: Sphinx 8.1.0Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html
Dependencies
sphinxcontrib-*dependencies.Patch by Adam Turner.
parskippackage from 2001 to 2018.Patch by Jean-François B.
Incompatible changes
sphinx.util.Tee.Patch by Adam Turner.
fvsetdefault is changed to'\\fvset{fontsize=auto}'from'\\fvset{fontsize=\\small}'.Code-blocks are unchanged as FreeMono is now loaded with
Scale=0.9.An adjustment to existing projects is needed only if they used a custom
fontpkgconfiguration and did not setfvset.Patch by Jean-François B.
zh_CNandzh_TWby default.Patch by A. Rafey Khan.
Deprecated
sphinx.util.import_object.Use
importlib.import_module()instead.Patch by Adam Turner.
sphinx.util.FilenameUniqDictand
sphinx.util.DownloadFiles.Patch by Adam Turner.
Features added
output files.
Patch by James Addison.
contents,topic,and
sidebardirectives separately customizable for PDF output.Patch by Jean-François B. and Bénédikt Tran.
Patch by Tim Hoffmann.
math_numsepsupport to latex builder.Patch by Thomas Fanning and Jean-François B.
--fail-on-warningis used.Instead, exit with a non-zero status if any warnings were generated
during the build.
Patch by Adam Turner.
sphinx-build --exception-on-warning,to raise an exception when warnings are emitted during the build.
Patch by Adam Turner and Jeremy Maitin-Shepard.
html_last_updated_use_utcto allow usinguniversal time (GMT/UTC) instead of local time for the date-time
supplied to
html_last_updated_fmt.Patch by Adam Turner.
'%Y'placeholderto substitute the current year.
This is helpful for reducing the reliance on Python modules
such as
timeordatetimeinconf.py.Patch by Adam Turner.
:cve:)and CWEs (
:cwe:).Patch by Hugo van Kemenade.
Patch by Jakub Stasiak and Adam Turner.
.Builder.supported_linkcodeattributefor builders to enable use of
sphinx.ext.linkcode-generatedreferences.
Patch by James Knight.
This can be helpful in diagnosing the cause of a full rebuild.
Patch by Adam Turner.
Bugs fixed
intersphinx_cache_limit.Patch by Shengyu Zhang.
Overfull \hboxfrom too longstrings in a codeline when the problem has actually been solved thanks
to
latexsphinxsetupforcewraps.Patch by Jean-François B.
UnreferencedFootnotesDetectortransform has been improvedto more consistently detect unreferenced footnotes.
Note, the priority of the transform has been changed from 200 to 622,
so that it now runs after the docutils
Footnotesresolution transform.Patch by Chris Sewell.
'sphinxsetup'div.topic_box-shadowkey if used with only one dimension set bothx-offset and y-offset as per documentation.
Patch by Jean-François B.
resolution occurs due to duplicate targets that differ case-insensitively.
Patch by James Addison.
Patch by Hugo van Kemenade.
Patch by Jeremy Bowman.
-q(quiet) option forsphinx-build -M latexpdformake latexpdf(O=-q)get passed to
latexmk. Let-Q(silent) apply as well to the PDF build phase.
Patch by Jean-François B.
rise to nested
\DUrole's, rather than a single one with comma separatedclasses.
Patch by Jean-François B.
Patch by Jean-François B.
references in the sense of RFC 3986, §4.4,
e.g.,
index.html#foobecomes#foo.(note: continuation of a partial fix added in Sphinx 7.3.0)
Patch by James Addison (with reference to prior work by Eric Norige).
Patch by Jean-François B. and Bénédikt Tran.
file URL (user-defined base URL of an intersphinx project are left untouched
even if they end with double forward slashes).
Patch by Bénédikt Tran.
even if there are fewer than 6 documents.
Patch by Matthias Geier.
:noindex:for thejs:moduleand
py:moduledirectives.Patch by Stephen Finucane.
_tsuffix during
apidocRST rendering (regression in 7.4.0).Patch by James Addison.
SOURCE_DATE_EPOCHfor entries that match the current system clock year,and disallow substitution of future years.
Patch by James Addison and Adam Turner.
intersphinx_cache_limit,which always kept the cache for positive values, and always refreshed it for
negative ones.
Patch by Nico Madysa.
and ensure deterministic resolution of global toctree in parallel builds
by choosing the lexicographically greatest parent document.
Patch by A. Rafey Khan
for Chinese languages.
Patch by Adam Turner.
.Builder.writeis typed asfinal, meaning that thewrite-startedevent may be relied upon by extensions.A new
.Builder.write_documentsmethod has been added tocontrol how documents are written.
This is intended for builders that do not output a file for each document.
Patch by Adam Turner.
Testing
karmaJavaScript test framework tothe actively-maintained
jasmineframework. Test coverage is unaffected.Patch by James Addison.
v8.0.2: Sphinx 8.0.2Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v8.0.1: Sphinx 8.0.1Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v8.0.0: Sphinx 8.0.0Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Dependencies
Incompatible changes
Remove deprecated functions from
sphinx.util:sphinx.util.path_stabilize(use
sphinx.util.osutil.path_stabilize).sphinx.util.display_chunk(use
sphinx.util.display.display_chunk).sphinx.util.status_iterator(use
sphinx.util.display.status_iterator).sphinx.util.SkipProgressMessage(use
sphinx.util.display.SkipProgressMessage).sphinx.util.progress_message(use
sphinx.util.display.progress_message).sphinx.util.epoch_to_rfc1123(use
sphinx.http_date.epoch_to_rfc1123).sphinx.util.rfc1123_to_epoch(use
sphinx.http_date.rfc1123_to_epoch).sphinx.util.save_traceback(use
sphinx.exceptions.save_traceback).sphinx.util.format_exception_cut_frames(use
sphinx.exceptions.format_exception_cut_frames).sphinx.util.xmlname_checker(use
sphinx.builders.epub3._XML_NAME_PATTERN).Patch by Adam Turner.
Removed
sphinx.util.osutil.cd(use
contextlib.chdir).Patch by Adam Turner.
Removed
sphinx.util.typing.stringify(use
sphinx.util.typing.stringify_annotation).Patch by Adam Turner.
#12593: Raise an error for invalid
html_sidebarsvalues.Patch by Adam Turner.
#12593: Raise an error in
Theme.get_configfor invalid sections.Patch by Adam Turner.
#11693: Remove support for old-style
Makefileandmake.batoutput in
sphinx-quickstart.#11693: Remove the
--no-use-make-mode,-M,--use-make-mode, and-moptionsfrom
sphinx-quickstart.Patch by Adam Turner.
Removed the tuple interface to
sphinx.ext.autodoc.ObjectMember.Patch by Adam Turner.
#12630: Sphinx 8 makes two changes to the
linkcheckconfiguration defaults:linkcheck_allow_unauthorizedis nowFalseby default.linkcheck_report_timeouts_as_brokenis nowFalseby default.Patch by James Addison.
#12597: Change the default of
show_warning_typesfrom
FalsetoTrue.Patch by Chris Sewell.
#12083: Remove support for the old (2008--2010) Sphinx 0.5 and Sphinx 0.6
intersphinx_mappingformat.Patch by Bénédikt Tran and Adam Turner.
#12096: Do not overwrite user-supplied files when copying assets
unless forced with
force=True.Patch by Adam Turner.
#12646: Remove
sphinx.util.inspect.isNewType.Use
isinstance(obj, typing.NewType)instead on Python 3.10 and newer.Patch by Adam Turner.
Remove the long-deprecated (since Sphinx 2) alias
to
VersionChangeinsphinx.directives.other(Deprecated since Sphinx 2).
Use
sphinx.domains.changeset.VersionChangedirectly.Patch by Adam Turner.
Deprecated
sphinx.ext.intersphinx.normalize_intersphinx_mappingto
sphinx.ext.intersphinx.validate_intersphinx_mapping.The old name will be removed in Sphinx 10.
Patch by Adam Turner.
pathlib.Pathobjects to Sphinx 9.Use
os.fspathto convert :py:class:~pathlib.Pathobjects to strings,or
pathlib.Path's methods to work with path objects.Patch by Adam Turner.
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.
This PR was generated by Mend Renovate. View the repository job log.