chore(deps): update dependency sphinx to v9
This MR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| sphinx (changelog) |
==4.5.0 -> ==9.0.0
|
⚠️ WarningSome dependencies could not be looked up. Check the Dependency Dashboard for more information.
Release Notes
sphinx-doc/sphinx (sphinx)
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
-
#13639: :py:meth:
!SphinxComponentRegistry.create_source_parserno 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: :mod:
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 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 :py:attr:
!.appattributes, includingbuilder.app,env.app,events.app, andSphinxTransform.app. Patch by Adam Turner. -
#13637: Deprecate the :py:meth:
!set_applicationmethod of :py:class:~sphinx.parsers.Parserobjects. Patch by Adam Turner. -
#13644: Deprecate the :py:attr:
!Parser.configand :py:attr:!envattributes. 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 :py:mod:
!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. -
#13631: :func:
!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
-
#13332: Add :confval:
doctest_fail_fastoption 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
fontawesome6package. Patch by Jean-François B. -
#13509: autodoc: Detect :py:func:
typing_extensions.overload <typing.overload>and :py:func:~typing.finaldecorators. 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
fontawesome7package. Patch by Jean-François B. -
#13508: autodoc: Initial support for :pep:
695type aliases. Patch by Martin Matouš, Jeremy Maitin-Shepard, and Adam Turner. -
#14023: Add the new :confval:
mathjax_config_pathoption to load MathJax configuration from a file. Patch by Randolf Scholz and Adam Turner. -
#14046: linkcheck: Add the :confval:
linkcheck_case_insensitive_urlsoption 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 :mod:
sphinx.ext.duration. Patch by Erik Bedard and Adam Turner. -
#14022: Use MathJax v4 by default in the :mod:
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. - #14029: intersphinx: Fix error in format string interpolation. Patch by Matthieu de Cibeins.
-
#13894: Add
source_code_parsertype to :confval:suppress_warningsfor grouping issues related to the C and C++ parsers. Patch by Valentin H.
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
:rst:dir:
tabularcolumnsspecifies automatic widths (L,R,C, orJ). 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 :rst:role: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 :confval:
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 improvesemantic HTML structure <https://html.spec.whatwg.org/multipage/text-level-semantics.html>__. Patch by Mark Ostroth. -
#13812 (discussion): LaTeX: long :rst:dir:
confvalvalue 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 :confval:
autodoc_type_aliaseswhen 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:mod:annotationlibformat. 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 :rst:dir:
js:functionarguments and errors. Patch by Shengyu Zhang.
Testing
v8.2.3: Sphinx 8.2.3
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
v8.2.2: Sphinx 8.2.2
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
v8.2.1: Sphinx 8.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
v8.2.0: Sphinx 8.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
Dependencies
- #13000: Drop Python 3.10 support.
Incompatible changes
-
#13044: Remove the internal and undocumented
has_equationsdata from theMathDomaindomain. The undocumentedMathDomain.has_equationsmethod now unconditionally returnsTrue. These are replaced by thehas_maths_elementskey of the page context dict. Patch by Adam Turner. -
#13227: HTML output for sequences of keys in the
kbdrole 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 targetingkbd.compoundor.kbd.compoundwill no longer have any effect. Patch by Adam Turner.
Deprecated
-
#13037: Deprecate the
SingleHTMLBuilder.fix_refurismethod. Patch by James Addison. -
#13083, #13330: Un-deprecate
sphinx.util.import_object. Patch by Matthias Geier.
Features added
-
#13173: Add a new
duplicate_declarationwarning type, withduplicate_declaration.candduplicate_declaration.cppsubtypes. 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
classoption to theautosummarydirective. 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
kbdrole as aSphinxRole. Patch by Adam Turner. - #13065: Enable colour by default in when running on CI. Patch by Adam Turner.
-
#13230: Allow supressing warnings from the
toctreedirective when a glob pattern doesn't match any documents, via the newtoc.empty_globwarning sub-type. Patch by Slawek Figiel. -
#9732: Add the new
autodoc.mocked_objectwarnings sub-type. Patch by Cyril Roelandt. -
#7630, #4824: autodoc: Use
.pyitype 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_signaturesandjavascript_trailing_comma_in_multi_line_signaturesconfiguration options. -
#13264: Rename the
mathdirective'snowrapoption tono-wrap. Patch by Adam Turner. -
#13269: Added the option to disable the use of type comments in
via the new
autodoc_use_type_commentsoption, which defaults toTruefor backwards compatibility. The default will change toFalsein Sphinx 10. Patch by Adam Turner. -
#9732: Add the new
ref.anywarnings 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 withinautodoc_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-subclassesoption to theinheritance-diagramdirective. 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:decorole to cross-reference decorator functions and methods in the Python domain. Patch by Adam Turner. -
#9169: Add the
intersphinx_resolve_selfoption 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-searchclass. Patch by Will Lachance. -
#13326: Remove hardcoding from handling
productionlistnodes in all writers, to improve flexibility. Patch by Adam Turner. -
#13335: Use
misc.highlighting_failuresubtype 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.apidocextension, 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
Mapto store per-file term scores. Patch by James Addison -
#13130: LaTeX docs:
pdflatexindex creation may fail for index entries in French. Seelatex_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_ignoreby overriding session-levelrequests.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
groupwiseforautodoc_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
pathlibtypes. 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
productionlistdirectives. 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.
v8.1.3: Sphinx 8.1.3
Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html
Bugs fixed
-
#13013: Restore support for
cut_lines()with no object type. Patch by Adam Turner.
v8.1.2: Sphinx 8.1.2
Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html
Bugs fixed
-
#13012: Expose
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.1
Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html
Bugs fixed
-
#13006: Use the preferred https://www.cve.org/ URL for
the
:cve:role. Patch by Hugo van Kemenade. -
#13007: LaTeX: Improve resiliency when the required
fontawesomeorfontawesome5packages are not installed. Patch by Jean-François B.
v8.1.0: Sphinx 8.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html
Dependencies
-
#12756: Add lower-bounds to the
sphinxcontrib-*dependencies. Patch by Adam Turner. -
#12833: Update the LaTeX
parskippackage from 2001 to 2018. Patch by Jean-François B.
Incompatible changes
-
#12763: Remove unused internal class
sphinx.util.Tee. Patch by Adam Turner. -
#12822: LaTeX: for Unicode engines, the
fvsetdefault is changed to'\\fvset{fontsize=auto}'from'\\fvset{fontsize=\\small}'. Code-blocks are unchanged as FreeMono is now loaded withScale=0.9. An adjustment to existing projects is needed only if they used a customfontpkgconfiguration and did not setfvset. Patch by Jean-François B. -
#12875: Disable smartquotes for languages:
zh_CNandzh_TWby default. Patch by A. Rafey Khan.
Deprecated
-
#12762: Deprecate
sphinx.util.import_object. Useimportlib.import_module()instead. Patch by Adam Turner. -
#12766: Deprecate
sphinx.util.FilenameUniqDictandsphinx.util.DownloadFiles. Patch by Adam Turner.
Features added
- #11328: Mention evaluation of templated content during production of static output files. Patch by James Addison.
-
#12704: LaTeX: make
contents,topic, andsidebardirectives separately customizable for PDF output. Patch by Jean-François B. and Bénédikt Tran. - #12474: Support type-dependent search result highlighting via CSS. Patch by Tim Hoffmann.
-
#12652: LaTeX: Add
math_numsepsupport to latex builder. Patch by Thomas Fanning and Jean-François B. -
#12743: No longer exit on the first warning when
--fail-on-warningis used. Instead, exit with a non-zero status if any warnings were generated during the build. Patch by Adam Turner. -
#12743: Add
sphinx-build --exception-on-warning, to raise an exception when warnings are emitted during the build. Patch by Adam Turner and Jeremy Maitin-Shepard. -
#12907: Add
html_last_updated_use_utcto allow using universal time (GMT/UTC) instead of local time for the date-time supplied tohtml_last_updated_fmt. Patch by Adam Turner. -
#12910: Copyright entries now support the
'%Y'placeholder to substitute the current year. This is helpful for reducing the reliance on Python modules such astimeordatetimeinconf.py. Patch by Adam Turner. -
#11781: Add roles for referencing CVEs (
:cve:) and CWEs (:cwe:). Patch by Hugo van Kemenade. - #11809: Improve the formatting for RFC section anchors. Patch by Jakub Stasiak and Adam Turner.
-
#12852: Support a
.Builder.supported_linkcodeattribute for builders to enable use ofsphinx.ext.linkcode-generated references. Patch by James Knight. - #12949: Print configuration options that differ from the pickled environment. This can be helpful in diagnosing the cause of a full rebuild. Patch by Adam Turner.
Bugs fixed
-
#12514: intersphinx: fix the meaning of a negative value for
intersphinx_cache_limit. Patch by Shengyu Zhang. -
#12722: LaTeX: avoid TeX reporting
Overfull \hboxfrom too long strings in a codeline when the problem has actually been solved thanks tolatexsphinxsetupforcewraps. Patch by Jean-François B. -
#12730: The
UnreferencedFootnotesDetectortransform has been improved to 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 docutilsFootnotesresolution transform. Patch by Chris Sewell. -
#12778: LaTeX: let
'sphinxsetup'div.topic_box-shadowkey if used with only one dimension set both x-offset and y-offset as per documentation. Patch by Jean-François B. - #12587: Do not warn when potential ambiguity detected during Intersphinx resolution occurs due to duplicate targets that differ case-insensitively. Patch by James Addison.
- #12639: Fix singular and plural search results text. Patch by Hugo van Kemenade.
- #12645: Correctly support custom gettext output templates. Patch by Jeremy Bowman.
-
#12717: LaTeX: let
-q(quiet) option forsphinx-build -M latexpdformake latexpdf(O=-q) get passed tolatexmk. Let-Q(silent) apply as well to the PDF build phase. Patch by Jean-François B. -
#12744: LaTeX: Classes injected by a custom interpreted text role now give
rise to nested
\DUrole's, rather than a single one with comma separated classes. Patch by Jean-François B. - #12831: LaTeX: avoid large voids sometimes occurring at page bottoms. Patch by Jean-François B.
-
#11970, #12551: singlehtml builder: make target URIs to be same-document
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). - #12735: Fix PEP 695 generic classes LaTeX output formatting. Patch by Jean-François B. and Bénédikt Tran.
- #12782: intersphinx: fix double forward slashes when generating the inventory 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.
- #12796: Enable parallel reading if requested, even if there are fewer than 6 documents. Patch by Matthias Geier.
-
#12844: Restore support for
:noindex:for thejs:moduleandpy:moduledirectives. Patch by Stephen Finucane. -
#12916: Restore support for custom templates named with the legacy
_tsuffix duringapidocRST rendering (regression in 7.4.0). Patch by James Addison. -
#12451: Only substitute copyright notice years with values from
SOURCE_DATE_EPOCHfor entries that match the current system clock year, and disallow substitution of future years. Patch by James Addison and Adam Turner. -
#12905: intersphinx: fix flipped use of
intersphinx_cache_limit, which always kept the cache for positive values, and always refreshed it for negative ones. Patch by Nico Madysa. - #12888: Add a warning when document is included in multiple toctrees and ensure deterministic resolution of global toctree in parallel builds by choosing the lexicographically greatest parent document. Patch by A. Rafey Khan
- #12995: Significantly improve performance when building the search index for Chinese languages. Patch by Adam Turner.
-
#12767:
.Builder.writeis typed asfinal, meaning that thewrite-startedevent may be relied upon by extensions. A new.Builder.write_documentsmethod has been added to control how documents are written. This is intended for builders that do not output a file for each document. Patch by Adam Turner.
Testing
-
#12141: Migrate from the deprecated
karmaJavaScript test framework to the actively-maintainedjasmineframework. Test coverage is unaffected. Patch by James Addison.
v8.0.2: Sphinx 8.0.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v8.0.1: Sphinx 8.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v8.0.0: Sphinx 8.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Dependencies
- #12633: Drop Python 3.9 support.
Incompatible changes
-
Remove deprecated functions from
sphinx.util:- Removed
sphinx.util.path_stabilize(usesphinx.util.osutil.path_stabilize). - Removed
sphinx.util.display_chunk(usesphinx.util.display.display_chunk). - Removed
sphinx.util.status_iterator(usesphinx.util.display.status_iterator). - Removed
sphinx.util.SkipProgressMessage(usesphinx.util.display.SkipProgressMessage). - Removed
sphinx.util.progress_message(usesphinx.util.display.progress_message). - Removed
sphinx.util.epoch_to_rfc1123(usesphinx.http_date.epoch_to_rfc1123). - Removed
sphinx.util.rfc1123_to_epoch(usesphinx.http_date.rfc1123_to_epoch). - Removed
sphinx.util.save_traceback(usesphinx.exceptions.save_traceback). - Removed
sphinx.util.format_exception_cut_frames(usesphinx.exceptions.format_exception_cut_frames). - Removed
sphinx.util.xmlname_checker(usesphinx.builders.epub3._XML_NAME_PATTERN).
Patch by Adam Turner.
- Removed
-
Removed
sphinx.util.osutil.cd(usecontextlib.chdir). Patch by Adam Turner. -
Removed
sphinx.util.typing.stringify(usesphinx.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 insphinx-quickstart. -
#11693: Remove the
--no-use-make-mode,-M,--use-make-mode, and-moptions fromsphinx-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_typesfromFalsetoTrue. 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. Useisinstance(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). Usesphinx.domains.changeset.VersionChangedirectly. Patch by Adam Turner.
Deprecated
-
#12643: Renamed
sphinx.ext.intersphinx.normalize_intersphinx_mappingtosphinx.ext.intersphinx.validate_intersphinx_mapping. The old name will be removed in Sphinx 10. Patch by Adam Turner. -
#12650, #12686, #12690: Extend the deprecation for string methods on
pathlib.Pathobjects to Sphinx 9. Useos.fspathto convert :py:class:~pathlib.Pathobjects to strings, orpathlib.Path's methods to work with path objects. Patch by Adam Turner.
v7.4.7: Sphinx 7.4.7
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.4.6: Sphinx 7.4.6
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.4.5: Sphinx 7.4.5
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.4.4: Sphinx 7.4.4
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.4.3: Sphinx 7.4.3
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.4.2: Sphinx 7.4.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.4.1: Sphinx 7.4.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.4.0: Sphinx 7.4.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.3.7: Sphinx 7.3.7
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.3.6: Sphinx 7.3.6
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.3.5: Sphinx 7.3.5
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.3.4: Sphinx 7.3.4
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.3.3: Sphinx 7.3.3
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.3.2: Sphinx 7.3.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.3.1: Sphinx 7.3.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.3.0: Sphinx 7.3.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.2.6: Sphinx 7.2.6
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.2.5: Sphinx 7.2.5
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.2.4: Sphinx 7.2.4
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.2.3: Sphinx 7.2.3
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.2.2: Sphinx 7.2.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.2.1: Sphinx 7.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.2.0: Sphinx 7.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.1.2: Sphinx 7.1.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.1.1: Sphinx 7.1.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.1.0: Sphinx 7.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v7.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.1.3
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.1.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.1.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v6.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v5.3.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v5.2.3
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v5.2.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v5.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v5.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v5.1.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v5.1.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v5.0.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v5.0.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v5.0.0
Configuration
-
If you want to rebase/retry this MR, check this box
This MR has been generated by Renovate Bot.