Commit 9f903c5
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?v=4&size=40){kind=avatar}
chore(deps): update dependency sphinx to v9 (#891)
This PR contains the following updates:
| Package | Change |
[Age](https://docs.renovatebot.com/merge-confidence/) |
[Confidence](https://docs.renovatebot.com/merge-confidence/) |
|---|---|---|---|
| [Sphinx](https://redirect.github.com/sphinx-doc/sphinx)
([changelog](https://www.sphinx-doc.org/en/master/changes.html)) |
`==7.4.7` -> `==9.0.4` |
|
|
---
### Release Notes
<details>
<summary>sphinx-doc/sphinx (Sphinx)</summary>
###
[`v9.0.4`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v9.0.4):
Sphinx 9.0.4
[Compare
Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v9.0.3...v9.0.4)
Changelog: <https://www.sphinx-doc.org/en/master/changes/9.0.html>
## Bugs fixed
-
[#​14143](https://redirect.github.com/sphinx-doc/sphinx/issues/14143):
Fix spurious build warnings when translators reorder references
in strings, or use translated display text in references.
Patch by Matt Wang.
###
[`v9.0.3`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v9.0.3):
Sphinx 9.0.3
[Compare
Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v9.0.2...v9.0.3)
Changelog: <https://www.sphinx-doc.org/en/master/changes/9.0.html>
## Bugs fixed
-
[#​14142](https://redirect.github.com/sphinx-doc/sphinx/issues/14142):
autodoc: Restore some missing exports in `sphinx.ext.autodoc`.
Patch by Adam Turner.
###
[`v9.0.2`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v9.0.2):
Sphinx 9.0.2
[Compare
Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v9.0.1...v9.0.2)
Changelog: <https://www.sphinx-doc.org/en/master/changes/9.0.html>
## Bugs fixed
-
[#​14142](https://redirect.github.com/sphinx-doc/sphinx/issues/14142):
autodoc: Restore `sphinx.ext.autodoc.mock`.
Patch by Adam Turner.
###
[`v9.0.1`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v9.0.1):
Sphinx 9.0.1
[Compare
Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v9.0.0...v9.0.1)
Changelog: <https://www.sphinx-doc.org/en/master/changes/9.0.html>
## Bugs fixed
-
[#​13942](https://redirect.github.com/sphinx-doc/sphinx/issues/13942):
autodoc: Restore the mapping interface for options objects.
Patch by Adam Turner.
-
[#​13942](https://redirect.github.com/sphinx-doc/sphinx/issues/13942):
autodoc: Deprecate the mapping interface for options objects.
Patch by Adam Turner.
-
[#​13387](https://redirect.github.com/sphinx-doc/sphinx/issues/13387):
Update translations.
###
[`v9.0.0`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v9.0.0):
Sphinx 9.0.0
Changelog: <https://www.sphinx-doc.org/en/master/changes/9.0.html>
## Dependencies
-
[#​13786](https://redirect.github.com/sphinx-doc/sphinx/issues/13786):
Support [Docutils
0.22](https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-22-2026-07-29).
Patch by Adam Turner.
## Incompatible changes
-
[#​13639](https://redirect.github.com/sphinx-doc/sphinx/issues/13639):
`SphinxComponentRegistry.create_source_parser` no longer
has an *app* parameter, instead taking *config* and *env*.
Patch by Adam Turner.
-
[#​13679](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/13751),
[#​14089](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/13355):
Don't include escaped title content in the search index.
Patch by Will Lachance.
## Deprecated
- 13627: Deprecate remaining public `app` attributes,
including `builder.app`, `env.app`, `events.app`,
and `SphinxTransform.app`.
Patch by Adam Turner.
-
[#​13637](https://redirect.github.com/sphinx-doc/sphinx/issues/13637):
Deprecate the `set_application` method
of `Parser` objects.
Patch by Adam Turner.
-
[#​13644](https://redirect.github.com/sphinx-doc/sphinx/issues/13644):
Deprecate the `Parser.config` and `env` attributes.
Patch by Adam Turner.
-
[#​13665](https://redirect.github.com/sphinx-doc/sphinx/issues/13665):
Deprecate support for non-UTF 8 source encodings,
scheduled for removal in Sphinx 10.
Patch by Adam Turner.
-
[#​13682](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/13631):
`sphinx.environment.adapters.toctree.global_toctree_for_doc`
and `sphinx.environment.BuildEnvironment.get_and_resolve_doctree`
will require a *tags* keyword argument from Sphinx 11.
It may optionally be passed from Sphinx 9 onwards.
Patch by Adam Turner.
## Features added
-
[#​13332](https://redirect.github.com/sphinx-doc/sphinx/issues/13332):
Add `doctest_fail_fast` option to exit after the first failed
test.
Patch by Till Hoffmann.
-
[#​13439](https://redirect.github.com/sphinx-doc/sphinx/issues/13439):
linkcheck: Permit warning on every redirect with
`linkcheck_allowed_redirects = {}`.
Patch by Adam Turner and James Addison.
-
[#​13497](https://redirect.github.com/sphinx-doc/sphinx/issues/13497):
Support C domain objects in the table of contents.
-
[#​13500](https://redirect.github.com/sphinx-doc/sphinx/issues/13500):
LaTeX: add support for `fontawesome6` package.
Patch by Jean-François B.
-
[#​13509](https://redirect.github.com/sphinx-doc/sphinx/issues/13509):
autodoc: Detect `typing_extensions.overload`
and `final` decorators.
Patch by Spencer Brown.
-
[#​13535](https://redirect.github.com/sphinx-doc/sphinx/issues/13535):
html search: Update to the latest version of Snowball (v3.0.1).
Patch by Adam Turner.
-
[#​13647](https://redirect.github.com/sphinx-doc/sphinx/issues/13647):
LaTeX: allow more cases of table nesting.
Patch by Jean-François B.
-
[#​13657](https://redirect.github.com/sphinx-doc/sphinx/issues/13657):
LaTeX: support CSS3 length units.
Patch by Jean-François B.
-
[#​13684](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/13805):
LaTeX: add support for `fontawesome7` package.
Patch by Jean-François B.
-
[#​13508](https://redirect.github.com/sphinx-doc/sphinx/issues/13508):
autodoc: Initial support for PEP 695 type aliases.
Patch by Martin Matouš, Jeremy Maitin-Shepard, and Adam Turner.
-
[#​14023](https://redirect.github.com/sphinx-doc/sphinx/issues/14023):
Add the new `mathjax_config_path` option
to load MathJax configuration from a file.
Patch by Randolf Scholz and Adam Turner.
-
[#​14046](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/14075):
autosummary: Provide more context in import exception stack traces.
Patch by Philipp A.
-
[#​13468](https://redirect.github.com/sphinx-doc/sphinx/issues/13468):
Add config options to `sphinx.ext.duration`.
Patch by Erik Bedard and Adam Turner.
-
[#​14022](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/14029):
intersphinx: Fix error in format string interpolation.
Patch by Matthieu de Cibeins.
## Bugs fixed
-
[#​13926](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/1327):
LaTeX: tables using longtable raise error if
`tabularcolumns` specifies automatic widths
(`L`, `R`, `C`, or `J`).
Patch by Jean-François B.
-
[#​3447](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/8828):
LaTeX: adding a footnote to a longtable cell causes table to occupy
full width.
Patch by Jean-François B.
-
[#​11498](https://redirect.github.com/sphinx-doc/sphinx/issues/11498):
LaTeX: Table in cell fails to build if it has many rows.
Patch by Jean-François B.
-
[#​11515](https://redirect.github.com/sphinx-doc/sphinx/issues/11515):
LaTeX: longtable does not allow nested table.
Patch by Jean-François B.
-
[#​11973](https://redirect.github.com/sphinx-doc/sphinx/issues/11973):
LaTeX: links in table captions do not work in PDF.
Patch by Jean-François B.
-
[#​12821](https://redirect.github.com/sphinx-doc/sphinx/issues/12821):
LaTeX: URLs/links in section titles should render in PDF.
Patch by Jean-François B.
-
[#​13369](https://redirect.github.com/sphinx-doc/sphinx/issues/13369):
Correctly parse and cross-reference unpacked type annotations.
Patch by Alicia Garcia-Raboso.
-
[#​13528](https://redirect.github.com/sphinx-doc/sphinx/issues/13528):
Add tilde `~` prefix support for `py:deco`.
Patch by Shengyu Zhang and Adam Turner.
-
[#​13597](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/13619):
LaTeX: possible duplicated footnotes in PDF from object signatures
(typically if `latex_show_urls` `= 'footnote'`).
Patch by Jean-François B.
-
[#​13635](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/13685):
gettext: Correctly ignore trailing backslashes.
Patch by Bénédikt Tran.
-
[#​13712](https://redirect.github.com/sphinx-doc/sphinx/issues/13712):
intersphinx: Don't add "v" prefix to non-numeric versions.
Patch by Szymon Karpinski.
-
[#​13688](https://redirect.github.com/sphinx-doc/sphinx/issues/13688):
HTML builder: Replace `<em class="property">` with
`<span class="property">` for attribute type annotations
to improve [semantic HTML
structure](https://html.spec.whatwg.org/multipage/text-level-semantics.html).
Patch by Mark Ostroth.
-
[#​13812](https://redirect.github.com/sphinx-doc/sphinx/issues/13812)
(discussion): LaTeX: long `confval` value does not wrap at
spaces in PDF.
Patch by Jean-François B.
-
[#​10785](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/13858):
doctest: doctest blocks are now correctly added to a group defined by
the
configuration variable `doctest_test_doctest_blocks`.
-
[#​13885](https://redirect.github.com/sphinx-doc/sphinx/issues/13885):
Coverage builder: Fix TypeError when warning about missing modules.
Patch by Damien Ayers.
-
[#​13929](https://redirect.github.com/sphinx-doc/sphinx/issues/13929):
Duplicate equation label warnings now have a new warning
sub-type, `ref.equation`.
Patch by Jared Dillard.
-
[#​13935](https://redirect.github.com/sphinx-doc/sphinx/issues/13935):
autoclass: parent class members no longer considered
directly defined in certain cases, depending on autodoc processing
order.
Patch by Jeremy Maitin-Shepard.
-
[#​13939](https://redirect.github.com/sphinx-doc/sphinx/issues/13939):
LaTeX: page break can separate admonition title from contents.
Patch by Jean-François B.
-
[#​14004](https://redirect.github.com/sphinx-doc/sphinx/issues/14004):
Fix `autodoc_type_aliases` when they appear in PEP 604
union syntax (`Alias | Type`).
Patch by Tamika Nomara.
-
[#​14059](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/13916):
HTML Search: do not clear text fragments from the URL on page load.
Patch by Harmen Stoppels.
-
[#​13944](https://redirect.github.com/sphinx-doc/sphinx/issues/13944):
autodoc: show traceback during import in human readable representation.
Patch by Florian Best.
-
[#​14006](https://redirect.github.com/sphinx-doc/sphinx/issues/14006):
Support images with data URIs that aren't base64-encoded.
Patch by Shengyu Zhang and Adam Turner.
-
[#​12797](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/13945):
autodoc: Fix handling of undefined names in annotations by using
the `FORWARDREF` `annotationlib` format.
Patch by Rui Pinheiro and Adam Turner.
-
[#​14067](https://redirect.github.com/sphinx-doc/sphinx/issues/14067):
EPUB: unify path separators in manifest items to forward slashes;
resolve duplicates in the manifest on Windows.
Patch by Akihiro Takizawa.
-
[#​13741](https://redirect.github.com/sphinx-doc/sphinx/issues/13741):
text builder: fix an infinite loop when processing CSV tables.
Patch by Bénédikt Tran.
-
[#​13217](https://redirect.github.com/sphinx-doc/sphinx/issues/13217):
Remove extra parentheses from `js:function` arguments and errors.
Patch by Shengyu Zhang.
###
[`v8.2.3`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v8.2.3):
Sphinx 8.2.3
[Compare
Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v8.2.2...v8.2.3)
Changelog: <https://www.sphinx-doc.org/en/master/changes/8.2.html>
###
[`v8.2.2`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v8.2.2):
Sphinx 8.2.2
[Compare
Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v8.2.1...v8.2.2)
Changelog: <https://www.sphinx-doc.org/en/master/changes/8.2.html>
###
[`v8.2.1`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v8.2.1):
Sphinx 8.2.1
[Compare
Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v8.2.0...v8.2.1)
Changelog: <https://www.sphinx-doc.org/en/master/changes/8.2.html>
###
[`v8.2.0`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v8.2.0):
Sphinx 8.2.0
[Compare
Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v8.1.3...v8.2.0)
Changelog: <https://www.sphinx-doc.org/en/master/changes/8.2.html>
## Dependencies
-
[#​13000](https://redirect.github.com/sphinx-doc/sphinx/issues/13000):
Drop Python 3.10 support.
## Incompatible changes
-
[#​13044](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/13227):
HTML output for sequences of keys in the `kbd` role
no longer uses a `<kbd class="kbd compound">` element to wrap
the keys and separators, but places them directly in the relevant parent
node.
This means that CSS rulesets targeting `kbd.compound` or `.kbd.compound`
will no longer have any effect.
Patch by Adam Turner.
## Deprecated
-
[#​13037](https://redirect.github.com/sphinx-doc/sphinx/issues/13037):
Deprecate the `SingleHTMLBuilder.fix_refuris` method.
Patch by James Addison.
-
[#​13083](https://redirect.github.com/sphinx-doc/sphinx/issues/13083),
[#​13330](https://redirect.github.com/sphinx-doc/sphinx/issues/13330):
Un-deprecate `sphinx.util.import_object`.
Patch by Matthias Geier.
## Features added
-
[#​13173](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/11824):
linkcode: Allow extensions to add support for a domain by defining
the keys that should be present.
Patch by Nicolas Peugnet.
-
[#​13144](https://redirect.github.com/sphinx-doc/sphinx/issues/13144):
Add a `class` option to the `autosummary` directive.
Patch by Tim Hoffmann.
-
[#​13146](https://redirect.github.com/sphinx-doc/sphinx/issues/13146):
Napoleon: Unify the type preprocessing logic to allow
Google-style docstrings to use the optional and default keywords.
Patch by Chris Barrick.
-
[#​13227](https://redirect.github.com/sphinx-doc/sphinx/issues/13227):
Implement the `kbd` role as a `SphinxRole`.
Patch by Adam Turner.
-
[#​13065](https://redirect.github.com/sphinx-doc/sphinx/issues/13065):
Enable colour by default in when running on CI.
Patch by Adam Turner.
-
[#​13230](https://redirect.github.com/sphinx-doc/sphinx/issues/13230):
Allow supressing warnings from the `toctree` directive
when a glob pattern doesn't match any documents,
via the new `toc.empty_glob` warning sub-type.
Patch by Slawek Figiel.
-
[#​9732](https://redirect.github.com/sphinx-doc/sphinx/issues/9732):
Add the new `autodoc.mocked_object` warnings sub-type.
Patch by Cyril Roelandt.
-
[#​7630](https://redirect.github.com/sphinx-doc/sphinx/issues/7630),
[#​4824](https://redirect.github.com/sphinx-doc/sphinx/issues/4824):
autodoc: Use `.pyi` type stub files
to auto-document native modules.
Patch by Adam Turner, partially based on work by Allie Fitter.
-
[#​12975](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/13264):
Rename the `math` directive's `nowrap` option
to `no-wrap`.
Patch by Adam Turner.
-
[#​13269](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/13272):
The Python and JavaScript module directives now support
the `:no-index-entry:` option.
Patch by Adam Turner.
-
[#​12233](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/13172):
Add support for short signatures in autosummary.
Patch by Tim Hoffmann.
-
[#​13271](https://redirect.github.com/sphinx-doc/sphinx/issues/13271):
Change the signature prefix for abstract methods
in the Python domain to *abstractmethod* from *abstract*.
Patch by Adam Turner.
-
[#​13271](https://redirect.github.com/sphinx-doc/sphinx/issues/13271):
Support the `:abstract:` option for
classes, methods, and properties in the Python domain.
Patch by Adam Turner.
-
[#​12507](https://redirect.github.com/sphinx-doc/sphinx/issues/12507):
Add the `collapsible <collapsible-admonitions>` option
to admonition directives.
Patch by Chris Sewell.
-
[#​8191](https://redirect.github.com/sphinx-doc/sphinx/issues/8191),
[#​8159](https://redirect.github.com/sphinx-doc/sphinx/issues/8159):
Add `include-subclasses` option to
the `inheritance-diagram` directive.
Patch by Walter Dörwald.
-
[#​11995](https://redirect.github.com/sphinx-doc/sphinx/issues/11995):
autodoc: Add support for `python_display_short_literal_types`.
Patch by Bénédikt Tran and Adam Turner.
-
[#​13163](https://redirect.github.com/sphinx-doc/sphinx/issues/13163):
Always print the full context when Sphinx encounters an internal error.
Patch by Kevin Deldycke and Adam Turner.
-
[#​13105](https://redirect.github.com/sphinx-doc/sphinx/issues/13105):
Introduce the `py:deco` role to cross-reference decorator
functions and methods in the Python domain.
Patch by Adam Turner.
-
[#​9169](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/11280):
Add ability to skip a particular section using the `no-search` class.
Patch by Will Lachance.
-
[#​13326](https://redirect.github.com/sphinx-doc/sphinx/issues/13326):
Remove hardcoding from handling `productionlist`
nodes in all writers, to improve flexibility.
Patch by Adam Turner.
-
[#​13335](https://redirect.github.com/sphinx-doc/sphinx/issues/13335):
Use `misc.highlighting_failure` subtype for Pygments unknown lexers.
Patch by Bart Kamphorst.
-
[#​13354](https://redirect.github.com/sphinx-doc/sphinx/issues/13354):
Insert abbreviation nodes (hover text) for positional- and keyword-only
separators in Python signatures.
Patch by Adam Turner.
-
[#​13333](https://redirect.github.com/sphinx-doc/sphinx/issues/13333):
Add the `sphinx.ext.apidoc` extension,
to automate API documentation generation from Python modules.
Patch by Chris Sewell and Adam Turner.
## Bugs fixed
-
[#​12463](https://redirect.github.com/sphinx-doc/sphinx/issues/12463):
autosummary: Respect an empty module `__all__`.
Patch by Valentin Pratz
-
[#​13060](https://redirect.github.com/sphinx-doc/sphinx/issues/13060):
HTML Search: use `Map` to store per-file term scores.
Patch by James Addison
-
[#​13130](https://redirect.github.com/sphinx-doc/sphinx/issues/13130):
LaTeX docs: `pdflatex` index creation may fail for index entries
in French. See `latex_use_xindy`.
Patch by Jean-François B.
-
[#​13152](https://redirect.github.com/sphinx-doc/sphinx/issues/13152):
LaTeX: fix a typo from v7.4.0 in a default for `\sphinxboxsetup`.
Patch by Jean-François B.
-
[#​13096](https://redirect.github.com/sphinx-doc/sphinx/issues/13096):
HTML Search: check that query terms exist as properties in
term indices before accessing them.
-
[#​11233](https://redirect.github.com/sphinx-doc/sphinx/issues/11233):
linkcheck: match redirect URIs against `linkcheck_ignore` by
overriding session-level `requests.get_redirect_target`.
-
[#​13195](https://redirect.github.com/sphinx-doc/sphinx/issues/13195):
viewcode: Fix issue where import paths differ from the directory
structure.
Patch by Ben Egan and Adam Turner.
-
[#​13188](https://redirect.github.com/sphinx-doc/sphinx/issues/13188):
autodoc: fix detection of class methods implemented in C.
Patch by Bénédikt Tran.
-
[#​1810](https://redirect.github.com/sphinx-doc/sphinx/issues/1810):
Always copy static files when building, regardless of whether
any documents have changed since the previous build.
Patch by Adam Turner.
-
[#​13201](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/12975):
Avoid rendering a trailing comma in C and C++ multi-line signatures.
-
[#​13178](https://redirect.github.com/sphinx-doc/sphinx/issues/13178):
autodoc: Fix resolution for `pathlib` types.
Patch by Adam Turner.
-
[#​13136](https://redirect.github.com/sphinx-doc/sphinx/issues/13136):
autodoc: Correctly handle multiple inheritance.
Patch by Pavel Holica
-
[#​13273](https://redirect.github.com/sphinx-doc/sphinx/issues/13273),
[#​13318](https://redirect.github.com/sphinx-doc/sphinx/issues/13318):
Properly convert command-line overrides for Boolean types.
Patch by Adam Turner.
-
[#​13302](https://redirect.github.com/sphinx-doc/sphinx/issues/13302),
[#​13319](https://redirect.github.com/sphinx-doc/sphinx/issues/13319):
Use the correct indentation for continuation lines
in `productionlist` directives.
Patch by Adam Turner.
-
[#​13328](https://redirect.github.com/sphinx-doc/sphinx/issues/13328):
Fix parsing of PEP 695 functions with return annotations.
Patch by Bénédikt Tran. Initial work by Arash Badie-Modiri.
## Testing
-
[#​13224](https://redirect.github.com/sphinx-doc/sphinx/issues/13224):
Correctness fixup for `test_html_multi_line_copyright`.
Patch by Colin Watson, applied by James Addison.
###
[`v8.1.3`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v8.1.3):
Sphinx 8.1.3
[Compare
Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v8.1.2...v8.1.3)
Changelog: <https://www.sphinx-doc.org/en/master/changes/8.1.html>
## Bugs fixed
-
[#​13013](https://redirect.github.com/sphinx-doc/sphinx/issues/13013):
Restore support for `cut_lines()` with no object type. Patch by Adam
Turner.
###
[`v8.1.2`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v8.1.2):
Sphinx 8.1.2
[Compare
Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v8.1.1...v8.1.2)
Changelog: <https://www.sphinx-doc.org/en/master/changes/8.1.html>
## Bugs fixed
-
[#​13012](https://redirect.github.com/sphinx-doc/sphinx/issues/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.
###
[`v8.1.1`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v8.1.1):
Sphinx 8.1.1
[Compare
Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v8.1.0...v8.1.1)
Changelog: <https://www.sphinx-doc.org/en/master/changes/8.1.html>
## Bugs fixed
-
[#​13006](https://redirect.github.com/sphinx-doc/sphinx/issues/13006):
Use the preferred <https://www.cve.org/> URL for
the `:cve:` role.
Patch by Hugo van Kemenade.
-
[#​13007](https://redirect.github.com/sphinx-doc/sphinx/issues/13007):
LaTeX: Improve resiliency when the required
`fontawesome` or `fontawesome5` packages are not installed.
Patch by Jean-François B.
###
[`v8.1.0`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v8.1.0):
Sphinx 8.1.0
[Compare
Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v8.0.2...v8.1.0)
Changelog: <https://www.sphinx-doc.org/en/master/changes/8.1.html>
## Dependencies
-
[#​12756](https://redirect.github.com/sphinx-doc/sphinx/issues/12756):
Add lower-bounds to the `sphinxcontrib-*` dependencies.
Patch by Adam Turner.
-
[#​12833](https://redirect.github.com/sphinx-doc/sphinx/issues/12833):
Update the LaTeX `parskip` package from 2001 to 2018.
Patch by Jean-François B.
## Incompatible changes
-
[#​12763](https://redirect.github.com/sphinx-doc/sphinx/issues/12763):
Remove unused internal class `sphinx.util.Tee`.
Patch by Adam Turner.
-
[#​12822](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/12875):
Disable smartquotes for languages: `zh_CN` and `zh_TW` by default.
Patch by A. Rafey Khan.
## Deprecated
-
[#​12762](https://redirect.github.com/sphinx-doc/sphinx/issues/12762):
Deprecate `sphinx.util.import_object`.
Use `importlib.import_module()` instead.
Patch by Adam Turner.
-
[#​12766](https://redirect.github.com/sphinx-doc/sphinx/issues/12766):
Deprecate `sphinx.util.FilenameUniqDict`
and `sphinx.util.DownloadFiles`.
Patch by Adam Turner.
## Features added
-
[#​11328](https://redirect.github.com/sphinx-doc/sphinx/issues/11328):
Mention evaluation of templated content during production of static
output files.
Patch by James Addison.
-
[#​12704](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/12474):
Support type-dependent search result highlighting via CSS.
Patch by Tim Hoffmann.
-
[#​12652](https://redirect.github.com/sphinx-doc/sphinx/issues/12652):
LaTeX: Add `math_numsep` support to latex builder.
Patch by Thomas Fanning and Jean-François B.
-
[#​12743](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/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`.
Patch by Adam Turner.
-
[#​11781](https://redirect.github.com/sphinx-doc/sphinx/issues/11781):
Add roles for referencing CVEs (`:cve:`)
and CWEs (`:cwe:`).
Patch by Hugo van Kemenade.
-
[#​11809](https://redirect.github.com/sphinx-doc/sphinx/issues/11809):
Improve the formatting for RFC section anchors.
Patch by Jakub Stasiak and Adam Turner.
-
[#​12852](https://redirect.github.com/sphinx-doc/sphinx/issues/12852):
Support a `.Builder.supported_linkcode` attribute
for builders to enable use of `sphinx.ext.linkcode`-generated
references.
Patch by James Knight.
-
[#​12949](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/12514):
intersphinx: fix the meaning of a negative value for
`intersphinx_cache_limit`.
Patch by Shengyu Zhang.
-
[#​12722](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/12639):
Fix singular and plural search results text.
Patch by Hugo van Kemenade.
-
[#​12645](https://redirect.github.com/sphinx-doc/sphinx/issues/12645):
Correctly support custom gettext output templates.
Patch by Jeremy Bowman.
-
[#​12717](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/12831):
LaTeX: avoid large voids sometimes occurring at page bottoms.
Patch by Jean-François B.
-
[#​11970](https://redirect.github.com/sphinx-doc/sphinx/issues/11970),
[#​12551](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/12735):
Fix PEP 695 generic classes LaTeX output formatting.
Patch by Jean-François B. and Bénédikt Tran.
-
[#​12782](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/12796):
Enable parallel reading if requested,
even if there are fewer than 6 documents.
Patch by Matthias Geier.
-
[#​12844](https://redirect.github.com/sphinx-doc/sphinx/issues/12844):
Restore support for `:noindex:` for the `js:module`
and `py:module` directives.
Patch by Stephen Finucane.
-
[#​12916](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/12995):
Significantly improve performance when building the search index
for Chinese languages.
Patch by Adam Turner.
-
[#​12767](https://redirect.github.com/sphinx-doc/sphinx/issues/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.
## Testing
-
[#​12141](https://redirect.github.com/sphinx-doc/sphinx/issues/12141):
Migrate from the deprecated `karma` JavaScript test framework to
the actively-maintained `jasmine` framework. Test coverage is
unaffected.
Patch by James Addison.
###
[`v8.0.2`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v8.0.2):
Sphinx 8.0.2
[Compare
Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v8.0.1...v8.0.2)
Changelog: <https://www.sphinx-doc.org/en/master/changes.html>
###
[`v8.0.1`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v8.0.1):
Sphinx 8.0.1
[Compare
Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v8.0.0...v8.0.1)
Changelog: <https://www.sphinx-doc.org/en/master/changes.html>
###
[`v8.0.0`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v8.0.0):
Sphinx 8.0.0
[Compare
Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.4.7...v8.0.0)
Changelog: <https://www.sphinx-doc.org/en/master/changes.html>
## Dependencies
-
[#​12633](https://redirect.github.com/sphinx-doc/sphinx/issues/12633):
Drop Python 3.9 support.
## Incompatible changes
- 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](https://redirect.github.com/sphinx-doc/sphinx/issues/12593):
Raise an error for invalid `html_sidebars` values.
Patch by Adam Turner.
-
[#​12593](https://redirect.github.com/sphinx-doc/sphinx/issues/12593):
Raise an error in `Theme.get_config` for invalid sections.
Patch by Adam Turner.
-
[#​11693](https://redirect.github.com/sphinx-doc/sphinx/issues/11693):
Remove support for old-style `Makefile` and `make.bat`
output in `sphinx-quickstart`.
-
[#​11693](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/12597):
Change the default of `show_warning_types`
from `False` to `True`.
Patch by Chris Sewell.
-
[#​12083](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/12096):
Do not overwrite user-supplied files when copying assets
unless forced with `force=True`.
Patch by Adam Turner.
-
[#​12646](https://redirect.github.com/sphinx-doc/sphinx/issues/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.
## Deprecated
-
[#​12643](https://redirect.github.com/sphinx-doc/sphinx/issues/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](https://redirect.github.com/sphinx-doc/sphinx/issues/12650),
[#​12686](https://redirect.github.com/sphinx-doc/sphinx/issues/12686),
[#​12690](https://redirect.github.com/sphinx-doc/sphinx/issues/12690):
Extend the deprecation for string methods on
`pathlib.Path` objects to Sphinx 9.
Use `os.fspath` to convert :py:class:`~pathlib.Path` objects to strings,
or `pathlib.Path`'s methods to work with path objects.
Patch by Adam Turner.
</details>
---
### Configuration
📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).
🚦 **Automerge**: Enabled.
♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.
🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.
---
- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box
---
This PR was generated by [Mend Renovate](https://mend.io/renovate/).
View the [repository job
log](https://developer.mend.io/github/line/line-bot-sdk-python).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0Mi4zMi4yIiwidXBkYXRlZEluVmVyIjoiNDIuNTQuMiIsInRhcmdldEJyYW5jaCI6Im1hc3RlciIsImxhYmVscyI6WyJkZXBlbmRlbmN5IHVwZ3JhZGUiXX0=-->
---------
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Motoi Okuzono <[email protected]>1 parent d575cde commit 9f903c5
1 file changed
+4
-2
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
7 | | - | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
8 | 10 | | |
9 | 11 | | |
10 | 12 | | |
0 commit comments