sphinx-doc/sphinx (Sphinx)
### [`v7.3.7`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-737-released-Apr-19-2024)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.3.6...v7.3.7)
\=====================================
## Bugs fixed
- [#12299](https://togithub.com/sphinx-doc/sphinx/issues/12299): Defer loading themes defined via entry points until
their explicit use by the user or a child theme.
Patch by Adam Turner.
- [#12305](https://togithub.com/sphinx-doc/sphinx/issues/12305): Return the default value for `theme.get_config()` with
an unsupported theme configuration section.
Patch by Adam Turner.
### [`v7.3.6`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-736-in-development)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.3.5...v7.3.6)
\==============================
## Bugs fixed
- [#12295](https://togithub.com/sphinx-doc/sphinx/issues/12295): Re-export all AST types in the C and C++ domains.
Patch by Adam Turner.
- [#12295](https://togithub.com/sphinx-doc/sphinx/issues/12295): Re-export various objects from `sphinx.domains.python._annotations`
in `sphinx.domains.python`.
Patch by Jacob Chesslo and Adam Turner.
### [`v7.3.5`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-735-released-Apr-17-2024)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.3.4...v7.3.5)
\=====================================
## Bugs fixed
- [#12295](https://togithub.com/sphinx-doc/sphinx/issues/12295): Re-export various objects from `sphinx.domains.python._object`
in `sphinx.domains.python`.
Patch by Jacob Chesslo and Adam Turner.
### [`v7.3.4`](https://togithub.com/sphinx-doc/sphinx/releases/tag/v7.3.4): Sphinx 7.3.4
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.3.3...v7.3.4)
Changelog: https://www.sphinx-doc.org/en/master/changes.html
### [`v7.3.3`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-733-in-development)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.3.2...v7.3.3)
\==============================
## Bugs fixed
- [#12290](https://togithub.com/sphinx-doc/sphinx/issues/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.
### [`v7.3.2`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-732-released-Apr-17-2024)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.3.1...v7.3.2)
\=====================================
## Bugs fixed
- 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.
### [`v7.3.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-731-released-Apr-17-2024)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.3.0...v7.3.1)
\=====================================
## Dependencies
- Require `tomli` on Python 3.10 and earlier.
Patch by Adam Turner.
### [`v7.3.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-730-released-Apr-16-2024)
[Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.2.6...v7.3.0)
\=====================================
## Dependencies
- [#11411](https://togithub.com/sphinx-doc/sphinx/issues/11411): Support `Docutils 0.21`\_. Patch by Adam Turner.
.. \_Docutils 0.21: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-21-2024-04-09
- [#12012](https://togithub.com/sphinx-doc/sphinx/issues/12012): Use `types-docutils` instead of `docutils-stubs`.
## Deprecated
- [#11693](https://togithub.com/sphinx-doc/sphinx/issues/11693): Support for old-style :file:`Makefile` and :file:`make.bat` output
in :program:`sphinx-quickstart`, and the associated options :option:`!-M`,
:option:`!-m`, :option:`!--no-use-make-mode`, and :option:`!--use-make-mode`.
- [#11285](https://togithub.com/sphinx-doc/sphinx/issues/11285): Direct access to :attr:`!sphinx.testing.util.SphinxTestApp._status`
or :attr:`!sphinx.testing.util.SphinxTestApp._warning` is deprecated. Use
the public properties :attr:`!sphinx.testing.util.SphinxTestApp.status`
and :attr:`!sphinx.testing.util.SphinxTestApp.warning` instead.
Patch by Bénédikt Tran.
- tests: :func:`!sphinx.testing.util.strip_escseq` is deprecated in favour of
:func:`!sphinx.util.console.strip_colors`.
Patch by Bénédikt Tran.
## Features added
- [#12265](https://togithub.com/sphinx-doc/sphinx/issues/12265): Support theme configuration via `theme.toml`.
- [#11701](https://togithub.com/sphinx-doc/sphinx/issues/11701): HTML Search: Adopt the new `\`\_ element.
Patch by Bénédikt Tran.
.. \_`\`: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/search
- [#11803](https://togithub.com/sphinx-doc/sphinx/issues/11803): autodoc: Use an overriden `__repr__()` function in an enum,
if defined. Patch by Shengyu Zhang.
- [#11892](https://togithub.com/sphinx-doc/sphinx/issues/11892): Improved performance when resolving cross references in the C++ domain.
Patch by Rouslan Korneychuk.
- [#11981](https://togithub.com/sphinx-doc/sphinx/issues/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.
.. \_OSC 8: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
.. \_groff: https://lists.gnu.org/archive/html/groff/2021-10/msg00000.html
- [#11015](https://togithub.com/sphinx-doc/sphinx/issues/11015): Change the text of the :rst:dir:`versionadded` directive from
`New in [...]` to `Added in [...]`.
Patch by Bénédikt Tran.
- [#12131](https://togithub.com/sphinx-doc/sphinx/issues/12131): Added :confval:`show_warning_types` configuration option.
Patch by Chris Sewell.
- [#12193](https://togithub.com/sphinx-doc/sphinx/issues/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 :class:`sphinx.util.typing.ExtensionMetadata`.
This can be used by extension developers
to annotate the return type of their `setup` function.
Patch by Chris Sewell.
## Bugs fixed
- [#11668](https://togithub.com/sphinx-doc/sphinx/issues/11668): Raise a useful error when `theme.conf` is missing.
Patch by Vinay Sajip.
- [#11622](https://togithub.com/sphinx-doc/sphinx/issues/11622): Ensure that the order of keys in `searchindex.js` is deterministic.
Patch by Pietro Albini.
- [#11617](https://togithub.com/sphinx-doc/sphinx/issues/11617): ANSI control sequences are stripped from the output when writing to
a warnings file with :option:`-w `.
Patch by Bénédikt Tran.
- [#11666](https://togithub.com/sphinx-doc/sphinx/issues/11666): Skip all hidden directories in `CatalogRepository.pofiles`.
Patch by Aryaz Eghbali.
- [#9686](https://togithub.com/sphinx-doc/sphinx/issues/9686): html builder: Fix MathJax lazy loading when equations appear in titles.
Patch by Bénédikt Tran.
- [#11483](https://togithub.com/sphinx-doc/sphinx/issues/11483): singlehtml builder: Fix MathJax lazy loading when the index does not
contain any math equations.
Patch by Bénédikt Tran.
- [#11697](https://togithub.com/sphinx-doc/sphinx/issues/11697): HTML Search: add 'noindex' meta robots tag.
Patch by James Addison.
- [#11678](https://togithub.com/sphinx-doc/sphinx/issues/11678): Fix a possible `ZeroDivisionError` in `sphinx.ext.coverage`.
Patch by Stephen Finucane.
- [#11756](https://togithub.com/sphinx-doc/sphinx/issues/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](https://togithub.com/sphinx-doc/sphinx/issues/11675): Fix rendering of progression bars in environments that do not support
ANSI control sequences.
Patch by Bénédikt Tran.
- [#11715](https://togithub.com/sphinx-doc/sphinx/issues/11715): Apply `tls_verify` and `tls_cacerts` config to
`ImageDownloader`.
Patch by Nick Touran.
- [#11433](https://togithub.com/sphinx-doc/sphinx/issues/11433): Added the :confval:`linkcheck_allow_unauthorized` configuration option.
Set this option to `False` to report HTTP 401 (unauthorized) server
responses as broken.
Patch by James Addison.
- [#11868](https://togithub.com/sphinx-doc/sphinx/issues/11868): linkcheck: added a distinct `timeout` reporting status code.
This can be enabled by setting :confval:`linkcheck_report_timeouts_as_broken`
to `False`.
Patch by James Addison.
- [#11869](https://togithub.com/sphinx-doc/sphinx/issues/11869): Refresh the documentation for the `linkcheck_timeout` setting.
Patch by James Addison.
- [#11874](https://togithub.com/sphinx-doc/sphinx/issues/11874): Configure a default 30-second value for `linkcheck_timeout`.
Patch by James Addison.
- [#11886](https://togithub.com/sphinx-doc/sphinx/issues/11886): Print the Jinja2 template path chain in `TemplateNotFound` exceptions.
Patch by Colin Marquardt.
- [#11598](https://togithub.com/sphinx-doc/sphinx/issues/11598): Do not use query components in URLs for assets in EPUB rendering.
Patch by David Runge.
- [#11917](https://togithub.com/sphinx-doc/sphinx/issues/11917): Fix rendering of annotated inherited members for Python 3.9.
Patch by Janet Carson.
- [#11925](https://togithub.com/sphinx-doc/sphinx/issues/11925): Blacklist the `sphinxprettysearchresults` extension; the functionality
it provides was merged into Sphinx v2.0.0.
Patch by James Addison.
- [#11353](https://togithub.com/sphinx-doc/sphinx/issues/11353): Support enumeration classes inheriting from mixin or data types.
Patch by Bénédikt Tran.
- [#11962](https://togithub.com/sphinx-doc/sphinx/issues/11962): Fix target resolution when using `:paramtype:` fields.
Patch by Bénédikt Tran.
- [#12008](https://togithub.com/sphinx-doc/sphinx/issues/12008): Fix case-sensitive lookup of `std:label` names in intersphinx inventory.
Patch by Michael Goerz.
- [#11959](https://togithub.com/sphinx-doc/sphinx/issues/11959): Fix multiple term matching when word appears in both title and document.
Patch by Will Lachance.
- [#11958](https://togithub.com/sphinx-doc/sphinx/issues/11958): HTML Search: Fix partial matches overwriting full matches.
Patch by William Lachance.
- [#11944](https://togithub.com/sphinx-doc/sphinx/issues/11944): Use anchor in search preview.
Patch by Will Lachance.
- [#11474](https://togithub.com/sphinx-doc/sphinx/issues/11474): Fix doctrees caching causing files not be rebuilt in some cases,
e.g., when :confval:`numfig` is `True`.
Patch by Bénédikt Tran.
- [#11278](https://togithub.com/sphinx-doc/sphinx/issues/11278): autodoc: Fix rendering of :class:`functools.singledispatchmethod`
combined with :func:`@classmethod `.
Patch by Bénédikt Tran.
- [#11894](https://togithub.com/sphinx-doc/sphinx/issues/11894): Do not add checksums to css files if building using the htmlhelp builder.
Patch by mkay.
- [#12052](https://togithub.com/sphinx-doc/sphinx/issues/12052): Remove ` Githubissues.
Githubissues is a development platform for aggregating issues.
This PR contains the following updates:
7.2.6->7.3.7Release Notes
sphinx-doc/sphinx (Sphinx)
### [`v7.3.7`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-737-released-Apr-19-2024) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.3.6...v7.3.7) \===================================== ## Bugs fixed - [#12299](https://togithub.com/sphinx-doc/sphinx/issues/12299): Defer loading themes defined via entry points until their explicit use by the user or a child theme. Patch by Adam Turner. - [#12305](https://togithub.com/sphinx-doc/sphinx/issues/12305): Return the default value for `theme.get_config()` with an unsupported theme configuration section. Patch by Adam Turner. ### [`v7.3.6`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-736-in-development) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.3.5...v7.3.6) \============================== ## Bugs fixed - [#12295](https://togithub.com/sphinx-doc/sphinx/issues/12295): Re-export all AST types in the C and C++ domains. Patch by Adam Turner. - [#12295](https://togithub.com/sphinx-doc/sphinx/issues/12295): Re-export various objects from `sphinx.domains.python._annotations` in `sphinx.domains.python`. Patch by Jacob Chesslo and Adam Turner. ### [`v7.3.5`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-735-released-Apr-17-2024) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.3.4...v7.3.5) \===================================== ## Bugs fixed - [#12295](https://togithub.com/sphinx-doc/sphinx/issues/12295): Re-export various objects from `sphinx.domains.python._object` in `sphinx.domains.python`. Patch by Jacob Chesslo and Adam Turner. ### [`v7.3.4`](https://togithub.com/sphinx-doc/sphinx/releases/tag/v7.3.4): Sphinx 7.3.4 [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.3.3...v7.3.4) Changelog: https://www.sphinx-doc.org/en/master/changes.html ### [`v7.3.3`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-733-in-development) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.3.2...v7.3.3) \============================== ## Bugs fixed - [#12290](https://togithub.com/sphinx-doc/sphinx/issues/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. ### [`v7.3.2`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-732-released-Apr-17-2024) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.3.1...v7.3.2) \===================================== ## Bugs fixed - 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. ### [`v7.3.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-731-released-Apr-17-2024) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.3.0...v7.3.1) \===================================== ## Dependencies - Require `tomli` on Python 3.10 and earlier. Patch by Adam Turner. ### [`v7.3.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-730-released-Apr-16-2024) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.2.6...v7.3.0) \===================================== ## Dependencies - [#11411](https://togithub.com/sphinx-doc/sphinx/issues/11411): Support `Docutils 0.21`\_. Patch by Adam Turner. .. \_Docutils 0.21: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-21-2024-04-09 - [#12012](https://togithub.com/sphinx-doc/sphinx/issues/12012): Use `types-docutils` instead of `docutils-stubs`. ## Deprecated - [#11693](https://togithub.com/sphinx-doc/sphinx/issues/11693): Support for old-style :file:`Makefile` and :file:`make.bat` output in :program:`sphinx-quickstart`, and the associated options :option:`!-M`, :option:`!-m`, :option:`!--no-use-make-mode`, and :option:`!--use-make-mode`. - [#11285](https://togithub.com/sphinx-doc/sphinx/issues/11285): Direct access to :attr:`!sphinx.testing.util.SphinxTestApp._status` or :attr:`!sphinx.testing.util.SphinxTestApp._warning` is deprecated. Use the public properties :attr:`!sphinx.testing.util.SphinxTestApp.status` and :attr:`!sphinx.testing.util.SphinxTestApp.warning` instead. Patch by Bénédikt Tran. - tests: :func:`!sphinx.testing.util.strip_escseq` is deprecated in favour of :func:`!sphinx.util.console.strip_colors`. Patch by Bénédikt Tran. ## Features added - [#12265](https://togithub.com/sphinx-doc/sphinx/issues/12265): Support theme configuration via `theme.toml`. - [#11701](https://togithub.com/sphinx-doc/sphinx/issues/11701): HTML Search: Adopt the new `\