NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
PyPI
PyPI, #832 most downloaded on PyPI
Python documentation generator
Latest stable
9.2.0
Last release 1 months ago
21 Oct 2026
Release timing varies
gaps range from 9 days to 10 months
Nearly every release is documented
notes for 59 of the last 60 stable releases
1 version withdrawn
withdrawn after publishing
19 years old
243 releases · first in 2008
Drag across the ruler to compare, or tap a release to open it.
Changelog: https://www.sphinx-doc.org/en/master/changes.html
#14762: Drop Python 3.12 support. Patch by Adam Turner.
#14767: Support Docutils 0.23. Patch by Adam Turner.
Changelog: https://www.sphinx-doc.org/en/master/changes.html
#14465: LaTeX: PDF build crash since LaTeX June 2026 release if tables are styled with 'colorrows' (which is the default). Patch by Jean-François B.
#14229: Fix JavaScript search for languages whose stemmer class name does not match the language name, such as Chinese (which reuses the English stemmer) and Dutch (which uses the Dutch Porter stemmer). Patch by Hugo van Kemenade
Fixed support for Python 3.16 alpha 0 (changes in the enum module). Patch by Adam Turner
Your coding agent can read these notes before it upgrades. Set up the MCP server →
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
add_static_dir() for copying static
assets from extensions to the build output.
Patch by Jared Dillard:no-index-entry: for modules.
Patch by Adam TurnerHTMLThemeFactory objects in third-party extensions.
Patch by Adam Turner3.5.0 (#8854) of the documentation of
literalblockcappos key of sphinxsetup.
Patch by Jean-François B.Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
sphinx.ext.autodoc.
Patch by Adam Turner.Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
sphinx.ext.autodoc.mock.
Patch by Adam Turner.Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
13627: Deprecate remaining public app attributes, including builder.app, env.app, events.app, and SphinxTransform.app. Patch by Adam Turner.
Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
SphinxComponentRegistry.create_source_parser no longer
has an app parameter, instead taking config and env.
Patch by Adam Turner.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.app attributes,
including builder.app, env.app, events.app,
and SphinxTransform.app.
Patch by Adam Turner.set_application method
of Parser objects.
Patch by Adam Turner.Parser.config and env attributes.
Patch by Adam Turner.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.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.doctest_fail_fast option to exit after the first failed
test.
Patch by Till Hoffmann.linkcheck_allowed_redirects = {}.
Patch by Adam Turner and James Addison.fontawesome6 package.
Patch by Jean-François B.typing_extensions.overload
and final decorators.
Patch by Spencer Brown.fontawesome7 package.
Patch by Jean-François B.mathjax_config_path option
to load MathJax configuration from a file.
Patch by Randolf Scholz and Adam Turner.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.sphinx.ext.duration.
Patch by Erik Bedard and Adam Turner.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.tabularcolumns specifies automatic widths
(L, R, C, or J).
Patch by Jean-François B.~ prefix support for py:deco.
Patch by Shengyu Zhang and Adam Turner.latex_show_urls = 'footnote').
Patch by Jean-François B.<em class="property"> with
<span class="property"> for attribute type annotations
to improve semantic HTML structure.
Patch by Mark Ostroth.confval value does not wrap at
spaces in PDF.
Patch by Jean-François B.:py:data: to be hyperlinked in function signatures.doctest_test_doctest_blocks.ref.equation.
Patch by Jared Dillard.autodoc_type_aliases when they appear in PEP 604
union syntax (Alias | Type).
Patch by Tamika Nomara.babel-french).
Patch by Jean-François B.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.FORWARDREF annotationlib format.
Patch by Rui Pinheiro and Adam Turner.js:function arguments and errors.
Patch by Shengyu Zhang.#14143: Fix spurious build warnings when translators reorder references in strings, or use translated display text in references. Patch by Matt Wang.
#14142: autodoc: Restore some missing exports in !sphinx.ext.autodoc. Patch by Adam Turner.
#14142: autodoc: Restore !sphinx.ext.autodoc.mock. Patch by Adam Turner.
#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.
#13786: Support Docutils 0.22. Patch by Adam Turner.
#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.
#13664: HTML builder: !sphinx.builders.html.StandaloneHTMLBuilder.render_partial now returns fragment and title keys only. Patch by Adam Turner.
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 ~sphinx.parsers.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.
#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 ~typing.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 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.
#13894: Add source_code_parser type to suppress_warnings for grouping issues related to the C and C++ parsers. Patch by Valentin H.
#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.
Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
Nothing published for this version
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
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.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.SingleHTMLBuilder.fix_refuris method.
Patch by James Addison.sphinx.util.import_object.
Patch by Matthias Geier.duplicate_declaration warning type,
with duplicate_declaration.c and duplicate_declaration.cpp subtypes.
Patch by Julien Lecomte and Adam Turner.class option to the autosummary directive.
Patch by Tim Hoffmann.kbd role as a SphinxRole.
Patch by Adam Turner.toctree directive
when a glob pattern doesn't match any documents,
via the new toc.empty_glob warning sub-type.
Patch by Slawek Figiel.autodoc.mocked_object warnings sub-type.
Patch by Cyril Roelandt..pyi type stub files
to auto-document native modules.
Patch by Adam Turner, partially based on work by Allie Fitter.python_trailing_comma_in_multi_line_signatures and
javascript_trailing_comma_in_multi_line_signatures
configuration options.math directive's nowrap option
to no-wrap.
Patch by Adam Turner.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.ref.any warnings sub-type
to allow suppressing the ambiguous 'any' cross-reference warning.
Patch by Simão Afonso and Adam Turner.:no-index-entry: option.
Patch by Adam Turner.:no-index-entry:
and include the :no-index: and :no-index-entry: options within
autodoc_default_options.
Patch by Jonny Saunders and Adam Turner.:abstract: option for
classes, methods, and properties in the Python domain.
Patch by Adam Turner.collapsible <collapsible-admonitions> option
to admonition directives.
Patch by Chris Sewell.include-subclasses option to
the inheritance-diagram directive.
Patch by Walter Dörwald.python_display_short_literal_types.
Patch by Bénédikt Tran and Adam Turner.py:deco role to cross-reference decorator
functions and methods in the Python domain.
Patch by Adam Turner.intersphinx_resolve_self option
to resolve an intersphinx reference to the current project.
Patch by Jakob Lykke Andersen and Adam Turner.no-search class.
Patch by Will Lachance.productionlist
nodes in all writers, to improve flexibility.
Patch by Adam Turner.misc.highlighting_failure subtype for Pygments unknown lexers.
Patch by Bart Kamphorst.sphinx.ext.apidoc extension,
to automate API documentation generation from Python modules.
Patch by Chris Sewell and Adam Turner.__all__.
Patch by Valentin PratzMap to store per-file term scores.
Patch by James Addisonpdflatex index creation may fail for index entries
in French. See latex_use_xindy.
Patch by Jean-François B.\sphinxboxsetup.
Patch by Jean-François B.linkcheck_ignore by
overriding session-level requests.get_redirect_target.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.pathlib types.
Patch by Adam Turner.productionlist directives.
Patch by Adam Turner.test_html_multi_line_copyright.
Patch by Colin Watson, applied by James Addison.#13403: Define _StrPath.__radd__(). Patch by Adam Turner.
#13399: Fix _CurrentDocument membership testing with '{c,cpp}:parent_symbol'. Patch by Adam Turner.
#13392: Fix argument type for jieba.load_userdict().
Add workaround for nbsphinx implicit imports. Patch by Adam Turner.
#13402: Ensure inline <script/> tags are written exactly once. Patch by Dmitry Shachnev and Adam Turner.
#13391: apidoc: Fix TOC file not having a title. Patch by Dave Hoese and Adam Turner.
#13367: Correct spelling of highlighting_failure in warning sub-type. Patch by Bart Kamphorst.
#13377: Restore support for using sphinx.testing.path paths with sphinx.testing.fixtures. Patch by Kazuya Takei.
#13380: viewcode: Fix importing modules more than once. Patch by Dave Hoese.
#13382: Napoleon: Use the right valid types for configuration values. Patch by Adam Turner.
#13376: Fix copying assets from relative html_static_path and html_extra_path entries. Patch by Adam Turner.
#13000: Drop Python 3.10 support.
#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.
#13037: Deprecate the SingleHTMLBuilder.fix_refuris method. Patch by James Addison.
#13083, #13330: Un-deprecate sphinx.util.import_object. Patch by Matthias Geier.
#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 suppressing 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 math: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 option to admonition directives. Patch by Chris Sewell.
#8191, #8159: Add inheritance-diagram: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 ~sphinx.addnodes.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.
#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.
#13224: Correctness fixup for test_html_multi_line_copyright. Patch by Colin Watson, applied by James Addison.
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html
Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html
Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html
cut_lines() with no object type. Patch by Adam Turner.Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html
Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html
sphinx.errors.ExtensionError in sphinx.util for backwards compatibility. This will be removed in Sphinx 9, as exposing the exception in sphinx.util was never intentional. ExtensionError has been part of sphinx.errors since Sphinx 0.9. Patch by Adam Turner.Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html
Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html
:cve: role.
Patch by Hugo van Kemenade.fontawesome or fontawesome5 packages are not installed.
Patch by Jean-François B.Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html
Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html
sphinxcontrib-* dependencies.
Patch by Adam Turner.parskip package from 2001 to 2018.
Patch by Jean-François B.sphinx.util.Tee.
Patch by Adam Turner.fvset default 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
fontpkg configuration and did not set fvset.
Patch by Jean-François B.zh_CN and zh_TW by default.
Patch by A. Rafey Khan.sphinx.util.import_object.
Use importlib.import_module() instead.
Patch by Adam Turner.sphinx.util.FilenameUniqDict
and sphinx.util.DownloadFiles.
Patch by Adam Turner.contents, topic,
and sidebar directives separately customizable for PDF output.
Patch by Jean-François B. and Bénédikt Tran.math_numsep support to latex builder.
Patch by Thomas Fanning and Jean-François B.--fail-on-warning is 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_utc to allow using
universal time (GMT/UTC) instead of local time for the date-time
supplied to html_last_updated_fmt.
Patch by Adam Turner.'%Y' placeholder
to substitute the current year.
This is helpful for reducing the reliance on Python modules
such as time or datetime in conf.py.
Patch by Adam Turner.:cve:)
and CWEs (:cwe:).
Patch by Hugo van Kemenade..Builder.supported_linkcode attribute
for builders to enable use of sphinx.ext.linkcode-generated
references.
Patch by James Knight.intersphinx_cache_limit.
Patch by Shengyu Zhang.Overfull \hbox from too long
strings in a codeline when the problem has actually been solved thanks
to latexsphinxsetupforcewraps.
Patch by Jean-François B.UnreferencedFootnotesDetector transform 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 docutils Footnotes resolution transform.
Patch by Chris Sewell.'sphinxsetup'
div.topic_box-shadow key if used with only one dimension set both
x-offset and y-offset as per documentation.
Patch by Jean-François B.-q (quiet) option for
sphinx-build -M latexpdf or make latexpdf (O=-q)
get passed to latexmk. Let -Q
(silent) apply as well to the PDF build phase.
Patch by Jean-François B.\DUrole's, rather than a single one with comma separated
classes.
Patch by Jean-François B.index.html#foo becomes #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).:noindex: for the js:module
and py:module directives.
Patch by Stephen Finucane._t
suffix during apidoc RST rendering (regression in 7.4.0).
Patch by James Addison.SOURCE_DATE_EPOCH for 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..Builder.write is typed as final, meaning that the
write-started event may be relied upon by extensions.
A new .Builder.write_documents method 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.karma JavaScript test framework to
the actively-maintained jasmine framework. Test coverage is unaffected.
Patch by James Addison.#13013: Restore support for !cut_lines with no object type. Patch by Adam Turner.
#13012: Expose sphinx.errors.ExtensionError in sphinx.util for backwards compatibility. This will be removed in Sphinx 9, as exposing the exception in sphinx.util was never intentional. !ExtensionError has been part of sphinx.errors since Sphinx 0.9. Patch by Adam Turner.
#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 fontawesome or fontawesome5 packages are not installed. Patch by Jean-François B.
#12756: Add lower-bounds to the sphinxcontrib-* dependencies. Patch by Adam Turner.
#12833: Update the LaTeX parskip package from 2001 to 2018. Patch by Jean-François B.
#12763: Remove unused internal class sphinx.util.Tee. Patch by Adam Turner.
#12822: LaTeX: for Unicode engines, the fvset default 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 fontpkg configuration and did not set fvset. Patch by Jean-François B.
#12875: Disable smartquotes for languages: zh_CN and zh_TW by default. Patch by A. Rafey Khan.
#12762: Deprecate sphinx.util.import_object. Use importlib.import_module instead. Patch by Adam Turner.
#12766: Deprecate sphinx.util.FilenameUniqDict and sphinx.util.DownloadFiles. Patch by Adam Turner.
#11328: Mention evaluation of templated content during production of static output files. Patch by James Addison.
#12704: LaTeX: make contents, topic, and sidebar directives 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_numsep support to latex builder. Patch by Thomas Fanning and Jean-François B.
#12743: No longer exit on the first warning when --fail-on-warning is 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_utc to allow using universal time (GMT/UTC) instead of local time for the date-time supplied to html_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 as time or datetime in conf.py. See the docs for further detail. 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_linkcode attribute for builders to enable use of sphinx.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.
#12514: intersphinx: fix the meaning of a negative value for intersphinx_cache_limit. Patch by Shengyu Zhang.
#12722: LaTeX: avoid TeX reporting Overfull \hbox from too long strings in a codeline when the problem has actually been solved thanks to latexsphinxsetupforcewraps. Patch by Jean-François B.
#12730: The UnreferencedFootnotesDetector transform 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 docutils Footnotes resolution transform. Patch by Chris Sewell.
#12778: LaTeX: let 'sphinxsetup' div.topic_box-shadow key 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 for sphinx-build -M latexpdf or make latexpdf (O=-q) get passed to latexmk. 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#foo becomes #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 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 the js:module and py:module directives. Patch by Stephen Finucane.
#12916: Restore support for custom templates named with the legacy _t suffix during apidoc RST rendering (regression in 7.4.0). Patch by James Addison.
#12451: Only substitute copyright notice years with values from SOURCE_DATE_EPOCH for 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.write is typed as final, meaning that the write-started event may be relied upon by extensions. A new .Builder.write_documents method 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.
#12141: Migrate from the deprecated karma JavaScript test framework to the actively-maintained jasmine framework. Test coverage is unaffected. Patch by James Addison.
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Remove deprecated functions from sphinx.util:
Changelog: https://www.sphinx-doc.org/en/master/changes.html
#12633: Drop Python 3.9 support.
Remove deprecated functions from sphinx.util:
Removed sphinx.util.path_stabilize (use sphinx.util.osutil.path_stabilize).
Removed sphinx.util.display_chunk (use sphinx.util.display.display_chunk).
Removed sphinx.util.status_iterator (use sphinx.util.display.status_iterator).
Removed sphinx.util.SkipProgressMessage (use sphinx.util.display.SkipProgressMessage).
Removed sphinx.util.progress_message (use sphinx.util.display.progress_message).
Removed sphinx.util.epoch_to_rfc1123 (use sphinx.http_date.epoch_to_rfc1123).
Removed sphinx.util.rfc1123_to_epoch (use sphinx.http_date.rfc1123_to_epoch).
Removed sphinx.util.save_traceback (use sphinx.exceptions.save_traceback).
Removed sphinx.util.format_exception_cut_frames (use sphinx.exceptions.format_exception_cut_frames).
Removed 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_sidebars values. Patch by Adam Turner.
#12593: Raise an error in Theme.get_config for invalid sections. Patch by Adam Turner.
#11693: Remove support for old-style Makefile and make.bat output in sphinx-quickstart.
#11693: Remove the --no-use-make-mode, -M, --use-make-mode, and -m options from 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 linkcheck configuration defaults:
linkcheck_allow_unauthorized is now False by default.
linkcheck_report_timeouts_as_broken is now False by default.
Patch by James Addison.
#12597: Change the default of show_warning_types from False to True. Patch by Chris Sewell.
#12083: Remove support for the old (2008--2010) Sphinx 0.5 and Sphinx 0.6 intersphinx_mapping format. 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 VersionChange in sphinx.directives.other (Deprecated since Sphinx 2). Use sphinx.domains.changeset.VersionChange directly. Patch by Adam Turner.
#12643: Renamed sphinx.ext.intersphinx.normalize_intersphinx_mapping to sphinx.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.Path objects to Sphinx 9. Use os.fspath to convert ~pathlib.Path objects to strings, or pathlib.Path's methods to work with path objects. Patch by Adam Turner.
Fix the pygments.Formatter.__class_getitem__ patch. Patch by Adam Turner.
Patch pygments.Formatter.__class_getitem__ in Pygments 2.17. Patch by Adam Turner.
#12633: Drop Python 3.9 support.
Remove deprecated functions from sphinx.util:
Removed sphinx.util.path_stabilize (use sphinx.util.osutil.path_stabilize).
Removed sphinx.util.display_chunk (use sphinx.util.display.display_chunk).
Removed sphinx.util.status_iterator (use sphinx.util.display.status_iterator).
Removed sphinx.util.SkipProgressMessage (use sphinx.util.display.SkipProgressMessage).
Removed sphinx.util.progress_message (use sphinx.util.display.progress_message).
Removed sphinx.util.epoch_to_rfc1123 (use sphinx.http_date.epoch_to_rfc1123).
Removed sphinx.util.rfc1123_to_epoch (use sphinx.http_date.rfc1123_to_epoch).
Removed sphinx.util.save_traceback (use sphinx.exceptions.save_traceback).
Removed sphinx.util.format_exception_cut_frames (use sphinx.exceptions.format_exception_cut_frames).
Removed 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_sidebars values. Patch by Adam Turner.
#12593: Raise an error in !Theme.get_config for invalid sections. Patch by Adam Turner.
#11693: Remove support for old-style Makefile and make.bat output in sphinx-quickstart.
#11693: Remove the !--no-use-make-mode, !-M, !--use-make-mode, and !-m options from 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 linkcheck configuration defaults:
linkcheck_allow_unauthorized is now False by default.
linkcheck_report_timeouts_as_broken is now False by default.
Patch by James Addison.
#12597: Change the default of show_warning_types from False to True. Patch by Chris Sewell.
#12083: Remove support for the old (2008--2010) Sphinx 0.5 and Sphinx 0.6 intersphinx_mapping format. 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 !VersionChange in !sphinx.directives.other (Deprecated since Sphinx 2). Use !sphinx.domains.changeset.VersionChange directly. Patch by Adam Turner.
#12643: Renamed sphinx.ext.intersphinx.normalize_intersphinx_mapping to sphinx.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.Path objects to Sphinx 9. Use os.fspath to convert ~pathlib.Path objects to strings, or ~pathlib.Path's methods to work with path objects. Patch by Adam Turner.
Remove deprecated functions from sphinx.util:
Changelog: https://www.sphinx-doc.org/en/master/changes.html
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_sidebars values.
Patch by Adam Turner.
#12593: Raise an error in Theme.get_config for invalid sections.
Patch by Adam Turner.
#11693: Remove support for old-style Makefile and make.bat
output in sphinx-quickstart.
#11693: Remove the --no-use-make-mode, -M,
--use-make-mode, and -m options
from 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 linkcheck configuration defaults:
linkcheck_allow_unauthorized is now False by default.linkcheck_report_timeouts_as_broken is now False by default.Patch by James Addison.
#12597: Change the default of show_warning_types
from False to True.
Patch by Chris Sewell.
#12083: Remove support for the old (2008--2010) Sphinx 0.5 and Sphinx 0.6
intersphinx_mapping format.
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.
#12650: Remove support for string methods on pathlib.Path objects.
Use os.fspath to convert pathlib.Path objects to strings,
or pathlib.Path's methods to work with path objects.
Patch by Adam Turner.
#12646: Remove sphinx.util.inspect.isNewType.
Patch by Adam Turner.
Remove the long-deprecated (since Sphinx 2) alias
to VersionChange in
sphinx.directives.other
(Deprecated since Sphinx 2).
Use sphinx.domains.changeset.VersionChange directly.
Patch by Adam Turner.
sphinx.ext.intersphinx.normalize_intersphinx_mapping
to sphinx.ext.intersphinx.validate_intersphinx_mapping.
The old name will be removed in Sphinx 10.
Patch by Adam Turner.Full Changelog: https://github.com/sphinx-doc/sphinx/compare/v7.4.7...v8.0.0rc1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
#12096: Warn when files are overwritten in the build directory. Patch by Adam Turner and Bénédikt Tran.
#12620: Ensure that old-style object description options are respected. Patch by Adam Turner.
#12601, #12625: Support callable objects in ~typing.Annotated type metadata in the Python domain. Patch by Adam Turner.
#12601, #12622: Resolve ~typing.Annotated warnings with sphinx.ext.autodoc, especially when using dataclasses as type metadata. Patch by Adam Turner.
#12589, #12626: autosummary: Fix warnings with !autolink. Patch by Adam Turner.
#12589, #9743, #12609: autosummary: Do not add the package prefix when generating autosummary directives for modules within a package. Patch by Adam Turner.
#12613: Reduce log severity for ambiguity detection during inventory loading. Patch by James Addison.
#12593, #12600: Revert coercing the type of selected html_sidebars values to a list. Log an error message when string values are detected. Patch by Adam Turner.
#12594: LaTeX: since 7.4.0, seealso and other "light" admonitions now break PDF builds if they contain a figure directive; and also if they are contained in a table cell (rendered by tabulary). Patch by Jean-François B.
#12585, #12586: Do not warn when an intersphinx inventory contains case-insensitively ambiguous duplicate items. Patch by James Addison.
#12582: Restore support for list-styled source_suffix values with extensions that register parsers. Patch by Adam Turner.
#12580, #12583: Resolve failures with the C domain on incremental builds with Sphinx 7.3.7 and earlier. Patch by Adam Turner.
Fix invalid HTML when a rubric node with invalid heading-level is used. Patch by Adam Turner.
#12579, #12581: Restore support for typing.ParamSpec in autodoc. Patch by Adam Turner.
#12555: Drop Docutils 0.18.1 and Docutils 0.19 support. Patch by Adam Turner.
LaTeX: the xcolor package is now required (but is for example part of Ubuntu texlive-latex-recommended which has always been required).
LaTeX: the fontawesome5 LaTeX package is needed for the default choices of icons now used in admonition titles in PDF output; but if unavailable the PDF build will simply silently omit rendering such icons. Check the documentation of the iconpackage key of 'sphinxsetup' for more.
LaTeX: the sphinxlightbox environment is not used anymore, all types of admonitions use (by default) only sphinxheavybox.
#11165: Support the officially recommended .jinja suffix for template files. Patch by James Addison and Adam Turner
#12325: Flatten Union[Literal[T], Literal[U], ...] to Literal[T, U, ...] when turning annotations into strings. Patch by Adam Turner.
#12319: sphinx.ext.extlinks: Add extlink-{name} CSS class to links. Patch by Hugo van Kemenade.
#12387: Improve CLI progress message, when copying assets. Patch by INADA Nakoi and Bénédikt Tran.
#12361: Add .BuildEnvironment.parser. Patch by Chris Sewell.
#12358: Add .Sphinx.fresh_env_used. Patch by Chris Sewell.
#12329: Add detection of ambiguous std:label and std:term references during loading and resolution of Intersphinx targets. Patch by James Addison.
#12422: Do not duplicate "navigation" in aria-label of built-in themes. Patch by Thomas Weißschuh
#12421: Include project name in logo_alt of built-in themes. Patch by Thomas Weißschuh
#12448: Add sphinx-apidoc --remove-old option. Patch by Chris Sewell.
#12456: Add sphinx-autogen --remove-old option. Patch by Chris Sewell.
#12479: Add warning subtype toc.no_title. Patch by Ondřej Navrátil.
#12492: Add helper methods for parsing reStructuredText content into nodes from within a directive.
~sphinx.util.docutils.SphinxDirective.parse_content_to_nodes() parses the directive's content and returns a list of Docutils nodes.
~sphinx.util.docutils.SphinxDirective.parse_text_to_nodes() parses the provided text and returns a list of Docutils nodes.
~sphinx.util.docutils.SphinxDirective.parse_inline() parses the provided text into inline elements and text nodes.
Patch by Adam Turner.
#12258: Support typing_extensions.Unpack Patch by Bénédikt Tran and Adam Turner.
#12524: Add a class option to the toctree directive. Patch by Tim Hoffmann.
#12536: Add the confval directive. Patch by Adam Turner.
#12537: c_id_attributes, c_paren_attributes, cpp_id_attributes, and cpp_paren_attributes can now be a tuple of strings. c_extra_keywords, gettext_additional_targets, html_domain_indices, latex_domain_indices, and texinfo_domain_indices, can now be a set of strings. Patch by Adam Turner.
#12523: Added configuration option, math_numsep, to define the separator for math numbering. Patch by Thomas Fanning
#11592: Add coverage_modules to the coverage builder to allow explicitly specifying which modules should be documented. Patch by Stephen Finucane.
#7896, #11989: Add a py:type directive for documenting type aliases, and a py:type role for linking to them. Patch by Ashley Whetter.
#12549: Add optional description argument to .Sphinx.add_config_value. Patch by Chris Sewell.
#6792: Prohibit module import cycles in sphinx.ext.autosummary. Patch by Trevor Bekolay.
#12508: LaTeX: Revamped styling of all admonitions, with addition of a title row with icon. Patch by Jean-François B.
#11773: Display ~typing.Annotated annotations with their metadata in the Python domain. Patch by Adam Turner and David Stansby.
#12506: Add heading-level option to rubric directive. Patch by Chris Sewell.
#12567: Add the write-started event. Patch by Chris Sewell.
#12314: Properly format collections.abc.Callable in annotations. Patch by Adam Turner.
#12162: Fix a performance regression in the C domain that has been present since version 3.0.0. Patch by Donald Hunter.
#12320: Fix removal of anchors from search summaries (regression in 7.3.0). Patch by Will Lachance.
#12251: Fix merge_domaindata() in sphinx.ext.duration. Patch by Matthias Geier.
#12224: Properly detect WebP files. Patch by Benjamin Cabé.
#12380: LaTeX: Avoid footnote markers Page N when N is already the current page number. Patch by Jean-François B.
#12410: LaTeX: for French and 'lualatex' as latex_engine use babel as with 'xelatex' (and not polyglossia). Patch by Jean-François B.
#8807, #12520: LaTeX: let todolist produce correct hyperlinks in PDF. Patch by Jean-François B.
#12416: Ensure that configuration setting aliases are always synchronised when one value or the other is modified. Patch by Bénédikt Tran.
#12220: Fix loading custom template translations for en locale. Patch by Nicolas Peugnet.
#12459: Add valid-type arguments to the linkcheck_rate_limit_timeout configuration setting. Patch by James Addison.
#12331: Resolve data-URI-image-extraction regression from v7.3.0 affecting builders without native support for data-URIs in their output format. Patch by James Addison.
#12494: Fix invalid genindex.html file produced with translated docs (regression in 7.1.0). Patch by Nicolas Peugnet.
#11961: Omit anchor references from document title entries in the search index, removing duplication of search results. Patch by James Addison.
#12425: Use Docutils' SVG processing in the HTML builder and remove Sphinx's custom logic. Patch by Tunç Başar Köse.
#12391: Adjust scoring of matches during HTML search so that document main titles tend to rank higher than subsection titles. In addition, boost matches on the name of programming domain objects relative to title/subtitle matches. Patch by James Addison and Will Lachance.
#9634: Do not add a fallback language by stripping the country code. Patch by Alvin Wong.
#12352: Add domain objects to the table of contents in the same order as defined in the document. Previously, each domain used language-specific nesting rules, which removed control from document authors. Patch by Jakob Lykke Andersen and Adam Turner.
#11041: linkcheck: Ignore URLs that respond with non-Unicode content. Patch by James Addison.
#12543: Fix 695 formatting for LaTeX output. Patch by Bénédikt Tran.
karma: refactor HTML search tests to use fixtures generated by Sphinx. Patch by James Addison.
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
#12299: Defer loading themes defined via entry points until their explicit use by the user or a child theme. Patch by Adam Turner.
#12305: Return the default value for theme.get_config() with an unsupported theme configuration section. Patch by Adam Turner.
#12295: Re-export all AST types in the C and C++ domains. Patch by Adam Turner.
#12295: Re-export various objects from sphinx.domains.python._annotations in sphinx.domains.python. Patch by Jacob Chesslo and Adam Turner.
#12295: Re-export various objects from sphinx.domains.python._object in sphinx.domains.python. Patch by Jacob Chesslo and Adam Turner.
Handle cases when Any is not an instance of type. Patch by Adam Turner.
#12290: Fix a false-positive warning when setting a configuration value with Any as the valid type to a type other than the value's default. Patch by Adam Turner.
Preload all themes defined via entry points. Patch by Adam Turner.
Fix a bad interaction between the 'Furo' theme and the new-style for configuration values. Patch by Adam Turner.
Require tomli on Python 3.10 and earlier. Patch by Adam Turner.
#11858: Increase the minimum supported version of Alabaster to 0.7.14. Patch by Adam Turner.
#12267: Support Docutils 0.21. Patch by Adam Turner.
#12012: Use types-docutils instead of docutils-stubs.
#11693: Support for old-style Makefile and make.bat output in sphinx-quickstart, and the associated options !-M, !-m, !--no-use-make-mode, and !--use-make-mode.
#11285: Direct access to !sphinx.testing.util.SphinxTestApp._status or !sphinx.testing.util.SphinxTestApp._warning is deprecated. Use the public properties !sphinx.testing.util.SphinxTestApp.status and !sphinx.testing.util.SphinxTestApp.warning instead. Patch by Bénédikt Tran.
tests: !sphinx.testing.util.strip_escseq is deprecated in favour of !sphinx.util.console.strip_colors. Patch by Bénédikt Tran.
#12265: Support theme configuration via theme.toml.
#11701: HTML Search: Adopt the new <search> element. Patch by Bénédikt Tran.
#11776: Add long option names to sphinx-build. Patch by Hugo van Kemenade, Adam Turner, Bénédikt Tran, and Ezio Melotti.
Organise the sphinx-build options into groups. Patch by Adam Turner.
#11855: Defer computation of configuration values. Patch by Adam Turner.
Add :no-search: as an alias of the :nosearch: metadata field. Patch by Adam Turner.
#11803: autodoc: Use an overridden __repr__() function in an enum, if defined. Patch by Shengyu Zhang.
#11825: Allow custom targets in the manpage role. Patch by Nicolas Peugnet.
#11892: Improved performance when resolving cross references in the C++ domain. Patch by Rouslan Korneychuk.
#11905: Add a versionremoved directive. Patch by Hugo van Kemenade, Adam Turner, and C.A.M. Gerlach.
#11981: Improve rendering of signatures using slice syntax, e.g., def foo(arg: np.float64[:,:]) -> None: ....
The manpage builder now adds OSC 8 anchors to hyperlinks, using the groff device control command.
#11015: Change the text of the versionadded directive from New in [...] to Added in [...]. Patch by Bénédikt Tran.
#12131: Added show_warning_types configuration option. Patch by Chris Sewell.
#12193: Improve external warnings for unknown roles. In particular, suggest related role names if an object type is mistakenly used. Patch by Chris Sewell.
Add public type alias sphinx.util.typing.ExtensionMetadata. This can be used by extension developers to annotate the return type of their setup function. Patch by Chris Sewell.
#11668: Raise a useful error when theme.conf is missing. Patch by Vinay Sajip.
#11622: Ensure that the order of keys in searchindex.js is deterministic. Patch by Pietro Albini.
#11617: ANSI control sequences are stripped from the output when writing to a warnings file with -w. Patch by Bénédikt Tran.
#11666: Skip all hidden directories in CatalogRepository.pofiles. Patch by Aryaz Eghbali.
#9686: html builder: Fix MathJax lazy loading when equations appear in titles. Patch by Bénédikt Tran.
#11483: singlehtml builder: Fix MathJax lazy loading when the index does not contain any math equations. Patch by Bénédikt Tran.
#11697: HTML Search: add 'noindex' meta robots tag. Patch by James Addison.
#11678: Fix a possible ZeroDivisionError in sphinx.ext.coverage. Patch by Stephen Finucane.
#11756: LaTeX: build error with recent TeXLive due to missing substitutefont package (triggered if using fontenc with T2A option and document language is not a Cyrillic one). Patch by Jean-François B.
#11675: Fix rendering of progression bars in environments that do not support ANSI control sequences. Patch by Bénédikt Tran.
#11861: Whitelist more types with an incorrect __module__ attribute. Patch by Adam Turner.
#11715: Apply tls_verify and tls_cacerts config to ImageDownloader. Patch by Nick Touran.
Allow hyphens in group names for productionlist cross-references. Patch by Adam Turner.
#11433: Added the linkcheck_allow_unauthorized configuration option. Set this option to False to report HTTP 401 (unauthorized) server responses as broken. Patch by James Addison.
#11868: linkcheck: added a distinct timeout reporting status code. This can be enabled by setting linkcheck_report_timeouts_as_broken to False. Patch by James Addison.
#11869: Refresh the documentation for the linkcheck_timeout setting. Patch by James Addison.
#11874: Configure a default 30-second value for linkcheck_timeout. Patch by James Addison.
#11886: Print the Jinja2 template path chain in TemplateNotFound exceptions. Patch by Colin Marquardt.
#11598: Do not use query components in URLs for assets in EPUB rendering. Patch by David Runge.
#11904: Support unary subtraction when parsing annotations. Patch by James Addison.
#11925: Blacklist the sphinxprettysearchresults extension; the functionality it provides was merged into Sphinx v2.0.0. Patch by James Addison.
#11917: Fix rendering of annotated inherited members for Python 3.9. Patch by Janet Carson.
#11935: C Domain: Fix namespace-pop context. Patch by Frank Dana.
#11923: Avoid zombie processes when parallel builds fail. Patch by Felix von Drigalski.
#11353: Support enumeration classes inheriting from mixin or data types. Patch by Bénédikt Tran.
#11962: Fix target resolution when using :paramtype: fields. Patch by Bénédikt Tran.
#11944: Use anchor in search preview. Patch by Will Lachance.
#12008: Fix case-sensitive lookup of std:label names in intersphinx inventory. Patch by Michael Goerz.
#11958: HTML Search: Fix partial matches overwriting full matches. Patch by William Lachance.
#11959: Fix multiple term matching when word appears in both title and document. Patch by Will Lachance.
#11474: Fix doctrees caching causing files not be rebuilt in some cases, e.g., when numfig is True. Patch by Bénédikt Tran.
#11278: autodoc: Fix rendering of functools.singledispatchmethod combined with @classmethod. Patch by Bénédikt Tran.
#11894: Do not add checksums to css files if building using the htmlhelp builder. Patch by reduerK akiM.
#12052: Remove <script> and <style> tags from the content of search result summary snippets. Patch by James Addison.
#11578: HTML Search: Order non-main index entries after other results. Patch by Brad King.
#12147: autosummary: Fix a bug whereby the wrong file extension may be used, when multiple suffixes are specified in source_suffix. Patch by Sutou Kouhei.
#10786: improve the error message when a file to be copied (e.g., an asset) is removed during Sphinx execution. Patch by Bénédikt Tran.
#12040: HTML Search: Ensure that document titles that are partially-matched by the user search query are included in search results. Patch by James Addison.
#11970: singlehtml builder: make target URIs to be same-document references in the sense of RFC 3986, §4.4, e.g., index.html#foo becomes #foo. Patch by Eric Norige.
#12271: Partially revert Docutils' r9562 to fix EPUB files. Patch by Adam Turner.
#12253: Escape reserved path characters in the remote images post-transform download cache. Patch by James Addison and Adam Turner.
Reorganise tests into directories. Patch by Adam Turner.
Clean up global state in SphinxTestApp. Patch by Adam Turner.
#11285: !pytest.mark.sphinx and !sphinx.testing.util.SphinxTestApp accept warningiserror, keep_going and verbosity as keyword arguments. Patch by Bénédikt Tran.
#11285: !sphinx.testing.util.SphinxTestApp status and warning arguments are checked to be io.StringIO objects (the public API incorrectly assumed this without checking it). Patch by Bénédikt Tran.
Report the result of test_run_epubcheck as skipped instead of success when either Java or epubcheck are not available.
Use dynamic allocation of unused port numbers for the test HTTP(S) servers. As a side-effect, this removes the need for test server lockfiles, meaning that any remaining tests/test-server.lock files can safely be deleted.
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
#11679: Add the !SPHINX_AUTODOC_RELOAD_MODULES environment variable, which if set reloads modules when using autodoc with TYPE_CHECKING = True. Patch by Matt Wozniski and Adam Turner.
#11679: Use importlib.reload to reload modules in autodoc. Patch by Matt Wozniski and Adam Turner.
#11645: Fix a regression preventing autodoc from importing modules within packages that make use of if typing.TYPE_CHECKING: to guard circular imports needed by type checkers. Patch by Matt Wozniski.
#11634: Fixed inheritance diagram relative link resolution for sibling files in a subdirectory. Patch by Albert Shih.
#11659: Allow ?config=... in mathjax_path.
#11654: autodoc: Fail with a more descriptive error message when an object claims to be an instance of type, but is not a class. Patch by James Braza.
11620: Cease emitting source-read events for files read via the include directive.
11620: Add a new include-read for observing and transforming the content of included files via the include directive.
#11627: Restore support for copyright lines of the form YYYY when SOURCE_DATE_EPOCH is set.
#11618: Fix a regression in the MoveModuleTargets transform, introduced in #10478 (#9662).
#11649: linkcheck: Resolve hanging tests for timezones west of London and incorrect conversion from UTC to offsets from the UNIX epoch. Patch by Dmitry Shachnev and Adam Turner.
#11576: Require sphinxcontrib-serializinghtml 1.1.9.
Fix regression in autodoc.Documenter.parse_name().
Fix regression in JSON serialisation.
#11543: autodoc: Support positional-only parameters in classmethod methods when autodoc_preserve_defaults is True.
Restore support string methods on path objects. This is deprecated and will be removed in Sphinx 8. Use os.fspath to convert ~pathlib.Path objects to strings, or ~pathlib.Path's methods to work with path objects.
Fix the signature of the StateMachine.insert_input() patch, for when calling with keyword arguments.
Fixed membership testing (in) for the str interface of the asset classes (_CascadingStyleSheet and _JavaScript), which several extensions relied upon.
Fixed a type error in SingleFileHTMLBuilder._get_local_toctree, includehidden may be passed as a string or a boolean.
Fix :noindex: for PyModule and JSModule.
Restored the the str interface of the asset classes (_CascadingStyleSheet and _JavaScript), which several extensions relied upon. This will be removed in Sphinx 9.
Restored calls to Builder.add_{css,js}_file(), which several extensions relied upon.
Restored the private API TocTree.get_toctree_ancestors(), which several extensions relied upon.
#11511: Drop Python 3.8 support.
#11576: Require Pygments 2.14 or later.
#11512: Deprecate sphinx.util.md5 and sphinx.util.sha1. Use hashlib instead.
#11526: Deprecate sphinx.testing.path. Use os.path or pathlib instead.
#11528: Deprecate sphinx.util.split_index_msg and sphinx.util.split_into. Use sphinx.util.index_entries.split_index_msg instead.
Deprecate sphinx.builders.html.Stylesheet and sphinx.builders.html.Javascript. Use sphinx.application.Sphinx.add_css_file() and sphinx.application.Sphinx.add_js_file() instead.
#11582: Deprecate sphinx.builders.html.StandaloneHTMLBuilder.css_files and sphinx.builders.html.StandaloneHTMLBuilder.script_files. Use sphinx.application.Sphinx.add_css_file() and sphinx.application.Sphinx.add_js_file() instead.
#11459: Deprecate sphinx.ext.autodoc.preserve_defaults.get_function_def(). Patch by Bénédikt Tran.
#11526: Support os.PathLike types and pathlib.Path objects in many more places.
#5474: coverage: Print summary statistics tables. Patch by Jorge Leitao.
#6319: viewcode: Add viewcode_line_numbers to control whether line numbers are added to rendered source code. Patch by Ben Krikler.
#9662: Add the :no-typesetting: option to suppress textual output and only create a linkable anchor. Patch by Latosha Maltba.
#11221: C++: Support domain objects in the table of contents. Patch by Rouslan Korneychuk.
#10938: doctest: Add doctest_show_successes option. Patch by Trey Hunner.
#11533: Add :no-index:, :no-index-entry:, and :no-contents-entry:.
#11572: Improve debug logging of reasons why files are detected as out of date. Patch by Eric Larson.
#10678: Emit source-read events for files read via the include directive. Patch by Halldor Fannar.
#11570: Use short names when using 585 built-in generics. Patch by Riccardo Mori.
#11300: Improve SigElementFallbackTransform fallback logic and signature text elements nodes. See the documentation for more details. Patch by Bénédikt Tran.
Allow running Sphinx with python -m sphinx build ....
#11077: graphviz: Fix relative links from within the graph. Patch by Ralf Grubenmann.
#11529: Line Block in LaTeX builder outputs spurious empty token. Patch by Adrian Vollmer.
#11196: autosummary: Summary line extraction failed with "e.g."
#10614: Fixed a number of bugs in inheritance diagrams that resulted in missing or broken links. Patch by Albert Shih.
#9428: Exclude substitution definitions when running the gettext builder. Patch by Alvin Wong.
#10795: Raise a descriptive error if graphviz_dot is falsy.
#11546: Translated nodes identical to their original text are now marked with the translated=True attribute.
#10049: html: Change "Permalink" to "Link" for title text in link anchors.
#4225: Relax Pygments parsing on lexing failures.
#11246: Allow inline links in the first line of a docstring and one-line type comments #: :meta ...: when using sphinx.ext.napoleon. Patch by Bénédikt Tran.
#10930: Highlight all search terms on the search results page. Patch by Dmitry Shachnev.
#11473: Type annotations containing ~typing.Literal enumeration values now render correctly. Patch by Bénédikt Tran.
#11591: Fix support for C coverage in sphinx.ext.coverage extension. Patch by Stephen Finucane.
#11594: HTML Theme: Enhancements to horizontal scrolling on smaller devices in the agogo theme. Patch by Lukas Engelter.
#11459: Fix support for async and lambda functions in sphinx.ext.autodoc.preserve_defaults. Patch by Bénédikt Tran.
#11577: pytest: Fail tests on "XPASS".
#11577: pytest: Use "importlib" import mode.
#11577: pytest: Set PYTHONWARNINGS=error.
#11577: pytest: Set strict config and strict markers.
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
#11542: linkcheck: Properly respect linkcheck_anchors and do not spuriously report failures to validate anchors. Patch by James Addison.
#11514: Fix SOURCE_DATE_EPOCH in multi-line copyright footer. Patch by Bénédikt Tran.
Releases are no longer signed, given the change in PyPI policy.
#11412: Emit warnings on using a deprecated Python-specific index entry type (namely, module, keyword, operator, object, exception, statement, and builtin) in the index directive, and set the removal version to Sphinx 9. Patch by Adam Turner.
#11415: Add a checksum to JavaScript and CSS asset URIs included within generated HTML, using the CRC32 algorithm.
~sphinx.application.Sphinx.require_sphinx now allows the version requirement to be specified as (major, minor).
#11011: Allow configuring a line-length limit for object signatures, via maximum_signature_line_length and the domain-specific variants. If the length of the signature (in characters) is greater than the configured limit, each parameter in the signature will be split to its own logical line. This behaviour may also be controlled by options on object description directives, for example py:function:single-line-parameter-list. Patch by Thomas Louf, Adam Turner, and Jean-François B.
#10983: Support for multiline copyright statements in the footer block. Patch by Stefanie Molin
sphinx.util.display.status_iterator now clears the current line with ANSI control codes, rather than overprinting with space characters.
#11431: linkcheck: Treat SSL failures as broken links. Patch by James Addison.
#11157: Keep the translated attribute on translated nodes.
#11451: Improve the traceback displayed when using sphinx-build -T in parallel builds. Patch by Bénédikt Tran
#11324: linkcheck: Use session-basd HTTP requests.
#11438: Add support for the py:class and py:function directives for PEP 695 (generic classes and functions declarations) and PEP 696 (default type parameters). Multi-line support (#11011) is enabled for type parameters list and can be locally controlled on object description directives, e.g., py:function:single-line-type-parameter-list. Patch by Bénédikt Tran.
#11484: linkcheck: Allow HTML anchors to be ignored on a per-URL basis via linkcheck_anchors_ignore_for_url while still checking the validity of the page itself. Patch by Bénédikt Tran
#1246: Add translation progress statistics and inspection support, via a new substitution (|translation progress|) and a new configuration variable (translation_progress_classes). These enable determining the percentage of translated elements within a document, and the remaining translated and untranslated elements.
Restored the footnote-reference class that has been removed in the latest (unreleased) version of Docutils.
#11486: Use 8081 font file MIME types in the EPUB builder. Using the correct MIME type will prevent warnings from epubcheck and will generate a valid EPUB.
#11435: Use microsecond-resolution timestamps for outdated file detection in BuildEnvironment.get_outdated_files.
#11437: Top-level headings starting with a reStructuredText role now render properly when rst_prolog is set. Previously, a file starting with the below would have improperly rendered due to where the prologue text was inserted into the document.
lobster -- The lobster module
====================================
...
Patch by Bénédikt Tran.
#11337: Fix a MemoryError in sphinx.ext.intersphinx when using None or typing.* as inline type references. Patch by Bénédikt Tran (picnixz)
#11345: Always delete docutils.conf in test directories when running SphinxTestApp.cleanup().
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
#11411: Support Docutils 0.20. Patch by Adam Turner.
#11418: Clean up remaining references to sphinx.setup_command following the removal of support for setuptools. Patch by Willem Mulder.
#11359: Remove long-deprecated aliases for MecabSplitter and DefaultSplitter in sphinx.search.ja.
#11360: Remove deprecated make_old_id functions in domain object description classes.
#11363: Remove the Setuptools integration (build_sphinx hook in setup.py).
#11364: Remove deprecated sphinx.ext.napoleon.iterators module.
#11365: Remove support for the jsdump format in sphinx.search.
#11366: Make locale a required argument to sphinx.util.i18n.format_date().
#11370: Remove deprecated sphinx.util.stemmer module.
#11371: Remove deprecated sphinx.pycode.ast.parse() function.
#11372: Remove deprecated sphinx.io.read_doc() function.
#11373: Removed deprecated sphinx.util.get_matching_files() function.
#11378: Remove deprecated sphinx.util.docutils.is_html5_writer_available() function.
#11379: Make the env argument to Builder subclasses required.
#11380: autosummary: Always emit grouped import exceptions.
#11381: Remove deprecated style key for HTML templates.
#11382: Remove deprecated sphinx.writers.latex.LaTeXTranslator.docclasses attribute.
#11383: Remove deprecated sphinx.builders.html.html5_ready and sphinx.builders.html.HTMLTranslator attributes.
#11385: Remove support for HTML 4 output.
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog: https://www.sphinx-doc.org/en/master/changes.html
#11355: Revert the default type of nitpick_ignore and nitpick_ignore_regex to list.
Require Docutils 0.18.1 or greater.
LaTeX: removal of some internal TeX \dimen registers (not previously publicly documented) as per 5.1.0 code comments in sphinx.sty: \sphinxverbatimsep, \sphinxverbatimborder, \sphinxshadowsep, \sphinxshadowsize, and \sphinxshadowrule. (refs: #11105)
Remove .egg support from pycode ModuleAnalyser; Python eggs are a now-obsolete binary distribution format
#11089: Remove deprecated code in sphinx.builders.linkcheck. Patch by Daniel Eades
Remove internal-only sphinx.locale.setlocale
#11247: Deprecate the legacy intersphinx_mapping format
sphinx.util.osutil.cd is deprecated in favour of contextlib.chdir.
#11277: autoproperty allows the return type to be specified as a type comment (e.g., # type: () -> int). Patch by Bénédikt Tran
#10811: Autosummary: extend __all__ to imported members for template rendering when option autosummary_ignore_module_all is set to False. Patch by Clement Pinard
#11147: Add a content_offset parameter to nested_parse_with_titles(), allowing for correct line numbers during nested parsing. Patch by Jeremy Maitin-Shepard
Update to Unicode CLDR 42
Add a --jobs synonym for -j. Patch by Hugo van Kemenade
LaTeX: a command \sphinxbox for styling text elements with a (possibly rounded) box, optional background color and shadow, has been added. See sphinxbox. (refs: #11224)
LaTeX: add \sphinxstylenotetitle, ..., \sphinxstylewarningtitle, ..., for an extra layer of mark-up freeing up \sphinxstrong for other uses. See latex-macros. (refs: #11267)
LaTeX: note, hint, important and tip can now each be styled as the other admonitions, i.e. possibly with a background color, individual border widths and paddings, possibly rounded corners, and optional shadow. See additionalcss. (refs: #11234)
LaTeX: admonitions and topic (and contents) directives, and not only code-block, support box-decoration-break=slice.
LaTeX: let rounded boxes support up to 4 distinct border-widths (refs: #11243)
LaTeX: new options noteTextColor, noteTeXextras et al. See additionalcss.
LaTeX: support elliptical corners in rounded boxes. (refs: #11254)
#11150: Include source location in highlighting warnings, when lexing fails. Patch by Jeremy Maitin-Shepard
#11281: Support for imgmath_latex = 'tectonic' or = 'xelatex'. Patch by Dimitar Dimitrov
#11109, #9643: Add python_display_short_literal_types option for condensed rendering of Literal types.
#11079: LaTeX: figures with align attribute may disappear and strangely impact following lists
#11093: LaTeX: fix "multiply-defined references" PDF build warnings when one or more reST labels directly precede an py:module or automodule directive. Patch by Bénédikt Tran (picnixz)
#11110: LaTeX: Figures go missing from latex pdf if their files have the same base name and they use a post transform. Patch by aaron-cooper
LaTeX: fix potential color leak from shadow to border of rounded boxes, if shadow color is set but border color is not
LaTeX: fix unintended 1pt upwards vertical shift of code blocks frames respective to contents (when using rounded corners)
#11235: LaTeX: added \color in topic (or admonition) contents may cause color leak to the shadow and border at a page break
#11264: LaTeX: missing space before colon after "Voir aussi" for seealso directive in French
#11268: LaTeX: longtable with left alignment breaks out of current list indentation context in PDF. Thanks to picnixz.
#11274: LaTeX: external links are not properly escaped for \sphinxupquote compatibility
#11147: Fix source file/line number info in object description content and in other uses of nested_parse_with_titles. Patch by Jeremy Maitin-Shepard.
#11192: Restore correct parallel search index building. Patch by Jeremy Maitin-Shepard
Use the new Transifex tx client
Fail testing when any Python warnings are emitted
Migrate remaining unittest.TestCase style test functions to pytest style
Remove tests that rely on setuptools
One column per quarter.