← Back to issue list

chore(deps): update documentation dependencies (major)

View original Github issue

Metadata

Project
rockcraft
Number
#538
Type
pull request
State
merged
Author
renovate[bot]
Labels
Created
Updated
Closed

Current evaluation

Merged automated dependency update upgrading Sphinx to 7.3.7 and sphinx-autodoc-typehints to 2.1.0. Approved by reviewers, passed CI, and merged with a minimal two-line change.

Suggested action:

No scores available.

Issue body

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [Sphinx](https://togithub.com/sphinx-doc/sphinx) ([changelog](https://www.sphinx-doc.org/en/master/changes.html)) | `==6.2.1` -> `==7.3.7` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/Sphinx/7.3.7?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/Sphinx/7.3.7?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/Sphinx/6.2.1/7.3.7?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/Sphinx/6.2.1/7.3.7?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [sphinx-autodoc-typehints](https://togithub.com/tox-dev/sphinx-autodoc-typehints) ([changelog](https://togithub.com/tox-dev/sphinx-autodoc-typehints/blob/main/CHANGELOG.md)) | `==1.23.0` -> `==2.1.0` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/sphinx-autodoc-typehints/2.1.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/sphinx-autodoc-typehints/2.1.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/sphinx-autodoc-typehints/1.23.0/2.1.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/sphinx-autodoc-typehints/1.23.0/2.1.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>sphinx-doc/sphinx (Sphinx)</summary> ### [`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 - [#&#8203;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. - [#&#8203;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-released-Apr-17-2024) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.3.5...v7.3.6) \===================================== ## Bugs fixed - [#&#8203;12295](https://togithub.com/sphinx-doc/sphinx/issues/12295): Re-export all AST types in the C and C++ domains. Patch by Adam Turner. - [#&#8203;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 - [#&#8203;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/blob/HEAD/CHANGES.rst#Release-734-released-Apr-17-2024) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.3.3...v7.3.4) \===================================== ## Bugs fixed - Handle cases when `Any` is not an instance of `type`. Patch by Adam Turner. ### [`v7.3.3`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-733-released-Apr-17-2024) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.3.2...v7.3.3) \===================================== ## Bugs fixed - [#&#8203;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 - [#&#8203;11858](https://togithub.com/sphinx-doc/sphinx/issues/11858): Increase the minimum supported version of Alabaster to 0.7.14. Patch by Adam Turner. - [#&#8203;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 - [#&#8203;12012](https://togithub.com/sphinx-doc/sphinx/issues/12012): Use `types-docutils` instead of `docutils-stubs`. ## Deprecated - [#&#8203;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`. - [#&#8203;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 - [#&#8203;12265](https://togithub.com/sphinx-doc/sphinx/issues/12265): Support theme configuration via `theme.toml`. - [#&#8203;11701](https://togithub.com/sphinx-doc/sphinx/issues/11701): HTML Search: Adopt the new `\<search\>`\_ element. Patch by Bénédikt Tran. .. \_`\<search\>`: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/search - [#&#8203;11776](https://togithub.com/sphinx-doc/sphinx/issues/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. - [#&#8203;11855](https://togithub.com/sphinx-doc/sphinx/issues/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. - [#&#8203;11803](https://togithub.com/sphinx-doc/sphinx/issues/11803): autodoc: Use an overriden `__repr__()` function in an enum, if defined. Patch by Shengyu Zhang. - [#&#8203;11825](https://togithub.com/sphinx-doc/sphinx/issues/11825): Allow custom targets in the manpage role. Patch by Nicolas Peugnet. - [#&#8203;11892](https://togithub.com/sphinx-doc/sphinx/issues/11892): Improved performance when resolving cross references in the C++ domain. Patch by Rouslan Korneychuk. - [#&#8203;11905](https://togithub.com/sphinx-doc/sphinx/issues/11905): Add a :rst:dir:`versionremoved` directive. Patch by Hugo van Kemenade, Adam Turner, and C.A.M. Gerlach. - [#&#8203;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 - [#&#8203;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. - [#&#8203;12131](https://togithub.com/sphinx-doc/sphinx/issues/12131): Added :confval:`show_warning_types` configuration option. Patch by Chris Sewell. - [#&#8203;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 - [#&#8203;11668](https://togithub.com/sphinx-doc/sphinx/issues/11668): Raise a useful error when `theme.conf` is missing. Patch by Vinay Sajip. - [#&#8203;11622](https://togithub.com/sphinx-doc/sphinx/issues/11622): Ensure that the order of keys in `searchindex.js` is deterministic. Patch by Pietro Albini. - [#&#8203;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 <sphinx-build -w>`. Patch by Bénédikt Tran. - [#&#8203;11666](https://togithub.com/sphinx-doc/sphinx/issues/11666): Skip all hidden directories in `CatalogRepository.pofiles`. Patch by Aryaz Eghbali. - [#&#8203;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. - [#&#8203;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. - [#&#8203;11697](https://togithub.com/sphinx-doc/sphinx/issues/11697): HTML Search: add 'noindex' meta robots tag. Patch by James Addison. - [#&#8203;11678](https://togithub.com/sphinx-doc/sphinx/issues/11678): Fix a possible `ZeroDivisionError` in `sphinx.ext.coverage`. Patch by Stephen Finucane. - [#&#8203;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. - [#&#8203;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. - [#&#8203;11861](https://togithub.com/sphinx-doc/sphinx/issues/11861): Whitelist more types with an incorrect `__module__` attribute. Patch by Adam Turner. - [#&#8203;11715](https://togithub.com/sphinx-doc/sphinx/issues/11715): Apply `tls_verify` and `tls_cacerts` config to `ImageDownloader`. Patch by Nick Touran. - Allow hyphens in group names for :rst:dir:`productionlist` cross-references. Patch by Adam Turner. - [#&#8203;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. - [#&#8203;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. - [#&#8203;11869](https://togithub.com/sphinx-doc/sphinx/issues/11869): Refresh the documentation for the `linkcheck_timeout` setting. Patch by James Addison. - [#&#8203;11874](https://togithub.com/sphinx-doc/sphinx/issues/11874): Configure a default 30-second value for `linkcheck_timeout`. Patch by James Addison. - [#&#8203;11886](https://togithub.com/sphinx-doc/sphinx/issues/11886): Print the Jinja2 template path chain in `TemplateNotFound` exceptions. Patch by Colin Marquardt. - [#&#8203;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. - [#&#8203;11904](https://togithub.com/sphinx-doc/sphinx/issues/11904): Support unary subtraction when parsing annotations. Patch by James Addison. - [#&#8203;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. - [#&#8203;11917](https://togithub.com/sphinx-doc/sphinx/issues/11917): Fix rendering of annotated inherited members for Python 3.9. Patch by Janet Carson. - [#&#8203;11935](https://togithub.com/sphinx-doc/sphinx/issues/11935): C Domain: Fix namespace-pop context. Patch by Frank Dana. - [#&#8203;11923](https://togithub.com/sphinx-doc/sphinx/issues/11923): Avoid zombie processes when parallel builds fail. Patch by Felix von Drigalski. - [#&#8203;11353](https://togithub.com/sphinx-doc/sphinx/issues/11353): Support enumeration classes inheriting from mixin or data types. Patch by Bénédikt Tran. - [#&#8203;11962](https://togithub.com/sphinx-doc/sphinx/issues/11962): Fix target resolution when using `:paramtype:` fields. Patch by Bénédikt Tran. - [#&#8203;11944](https://togithub.com/sphinx-doc/sphinx/issues/11944): Use anchor in search preview. Patch by Will Lachance. - [#&#8203;12008](https://togithub.com/sphinx-doc/sphinx/issues/12008): Fix case-sensitive lookup of `std:label` names in intersphinx inventory. Patch by Michael Goerz. - [#&#8203;11958](https://togithub.com/sphinx-doc/sphinx/issues/11958): HTML Search: Fix partial matches overwriting full matches. Patch by William Lachance. - [#&#8203;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. - [#&#8203;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. - [#&#8203;11278](https://togithub.com/sphinx-doc/sphinx/issues/11278): autodoc: Fix rendering of :class:`functools.singledispatchmethod` combined with :func:`@classmethod <classmethod>`. Patch by Bénédikt Tran. - [#&#8203;11894](https://togithub.com/sphinx-doc/sphinx/issues/11894): Do not add checksums to css files if building using the htmlhelp builder. Patch by reduerK akiM. - [#&#8203;12052](https://togithub.com/sphinx-doc/sphinx/issues/12052): Remove `<script>` and `<style>` tags from the content of search result summary snippets. Patch by James Addison. - [#&#8203;11578](https://togithub.com/sphinx-doc/sphinx/issues/11578): HTML Search: Order non-main index entries after other results. Patch by Brad King. - [#&#8203;12147](https://togithub.com/sphinx-doc/sphinx/issues/12147): autosummary: Fix a bug whereby the wrong file extension may be used, when multiple suffixes are specified in :confval:`source_suffix`. Patch by Sutou Kouhei. - [#&#8203;10786](https://togithub.com/sphinx-doc/sphinx/issues/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. - [#&#8203;12040](https://togithub.com/sphinx-doc/sphinx/issues/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. - [#&#8203;11970](https://togithub.com/sphinx-doc/sphinx/issues/11970): singlehtml builder: make target URIs to be same-document references in the sense of :rfc:`RFC 3986, §4.4 <3986#section-4.4>`, e.g., `index.html#foo` becomes `#foo`. Patch by Eric Norige. - [#&#8203;12271](https://togithub.com/sphinx-doc/sphinx/issues/12271): Partially revert Docutils' r9562\__ to fix EPUB files. Patch by Adam Turner. \__ https://sourceforge.net/p/docutils/code/9562/ - [#&#8203;12253](https://togithub.com/sphinx-doc/sphinx/issues/12253): Escape reserved path characters in the remote images post-transform download cache. Patch by James Addison and Adam Turner. ## Testing - Reorganise tests into directories. Patch by Adam Turner. - Clean up global state in `SphinxTestApp`. Patch by Adam Turner. - [#&#8203;11285](https://togithub.com/sphinx-doc/sphinx/issues/11285): :func:`!pytest.mark.sphinx` and :class:`!sphinx.testing.util.SphinxTestApp` accept *warningiserror*, *keep_going* and *verbosity* as keyword arguments. Patch by Bénédikt Tran. - [#&#8203;11285](https://togithub.com/sphinx-doc/sphinx/issues/11285): :class:`!sphinx.testing.util.SphinxTestApp` *status* and *warning* arguments are checked to be :class:`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. ### [`v7.2.6`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-726-released-Sep-13-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.2.5...v7.2.6) \===================================== ## Bugs fixed - [#&#8203;11679](https://togithub.com/sphinx-doc/sphinx/issues/11679): Add the :envvar:`!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. - [#&#8203;11679](https://togithub.com/sphinx-doc/sphinx/issues/11679): Use :py:func:`importlib.reload` to reload modules in autodoc. Patch by Matt Wozniski and Adam Turner. ### [`v7.2.5`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-725-released-Aug-30-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.2.4...v7.2.5) \===================================== ## Bugs fixed - [#&#8203;11645](https://togithub.com/sphinx-doc/sphinx/issues/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. - [#&#8203;11634](https://togithub.com/sphinx-doc/sphinx/issues/11634): Fixed inheritance diagram relative link resolution for sibling files in a subdirectory. Patch by Albert Shih. - [#&#8203;11659](https://togithub.com/sphinx-doc/sphinx/issues/11659): Allow `?config=...` in :confval:`mathjax_path`. - [#&#8203;11654](https://togithub.com/sphinx-doc/sphinx/issues/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 :event:`source-read` events for files read via the :dudir:`include` directive. - 11620: Add a new :event:`include-read` for observing and transforming the content of included files via the :dudir:`include` directive. - [#&#8203;11627](https://togithub.com/sphinx-doc/sphinx/issues/11627): Restore support for copyright lines of the form `YYYY` when `SOURCE_DATE_EPOCH` is set. ### [`v7.2.4`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-724-released-Aug-28-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.2.3...v7.2.4) \===================================== ## Bugs fixed - [#&#8203;11618](https://togithub.com/sphinx-doc/sphinx/issues/11618): Fix a regression in the MoveModuleTargets transform, introduced in [#&#8203;10478](https://togithub.com/sphinx-doc/sphinx/issues/10478) ([#&#8203;9662](https://togithub.com/sphinx-doc/sphinx/issues/9662)). - [#&#8203;11649](https://togithub.com/sphinx-doc/sphinx/issues/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. ### [`v7.2.3`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-723-released-Aug-23-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.2.2...v7.2.3) \===================================== ## Dependencies - [#&#8203;11576](https://togithub.com/sphinx-doc/sphinx/issues/11576): Require sphinxcontrib-serializinghtml 1.1.9. ## Bugs fixed - Fix regression in `autodoc.Documenter.parse_name()`. - Fix regression in JSON serialisation. - [#&#8203;11543](https://togithub.com/sphinx-doc/sphinx/issues/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 :py:func:`os.fspath` to convert :py:class:`~pathlib.Path` objects to strings, or :py:class:`~pathlib.Path`'s methods to work with path objects. ### [`v7.2.2`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-722-released-Aug-17-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.2.1...v7.2.2) \===================================== ## Bugs fixed - Fix the signature of the `StateMachine.insert_input()` patch, for when calling with keyword arguments. - Fixed membership testing (`in`) for the :py:class:`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`. ### [`v7.2.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-721-released-Aug-17-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.2.0...v7.2.1) \===================================== ## Bugs fixed - Restored the the :py:class:`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. ### [`v7.2.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-720-released-Aug-17-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.1.2...v7.2.0) \===================================== ## Dependencies - [#&#8203;11511](https://togithub.com/sphinx-doc/sphinx/issues/11511): Drop Python 3.8 support. - [#&#8203;11576](https://togithub.com/sphinx-doc/sphinx/issues/11576): Require Pygments 2.14 or later. ## Deprecated - [#&#8203;11512](https://togithub.com/sphinx-doc/sphinx/issues/11512): Deprecate `sphinx.util.md5` and `sphinx.util.sha1`. Use `hashlib` instead. - [#&#8203;11526](https://togithub.com/sphinx-doc/sphinx/issues/11526): Deprecate `sphinx.testing.path`. Use `os.path` or `pathlib` instead. - [#&#8203;11528](https://togithub.com/sphinx-doc/sphinx/issues/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. - [#&#8203;11582](https://togithub.com/sphinx-doc/sphinx/issues/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. - [#&#8203;11459](https://togithub.com/sphinx-doc/sphinx/issues/11459): Deprecate `sphinx.ext.autodoc.preserve_defaults.get_function_def()`. Patch by Bénédikt Tran. ## Features added - [#&#8203;11526](https://togithub.com/sphinx-doc/sphinx/issues/11526): Support `os.PathLike` types and `pathlib.Path` objects in many more places. - [#&#8203;5474](https://togithub.com/sphinx-doc/sphinx/issues/5474): coverage: Print summary statistics tables. Patch by Jorge Leitao. - [#&#8203;6319](https://togithub.com/sphinx-doc/sphinx/issues/6319): viewcode: Add :confval:`viewcode_line_numbers` to control whether line numbers are added to rendered source code. Patch by Ben Krikler. - [#&#8203;9662](https://togithub.com/sphinx-doc/sphinx/issues/9662): Add the `:no-typesetting:` option to suppress textual output and only create a linkable anchor. Patch by Latosha Maltba. - [#&#8203;11221](https://togithub.com/sphinx-doc/sphinx/issues/11221): C++: Support domain objects in the table of contents. Patch by Rouslan Korneychuk. - [#&#8203;10938](https://togithub.com/sphinx-doc/sphinx/issues/10938): doctest: Add :confval:`doctest_show_successes` option. Patch by Trey Hunner. - [#&#8203;11533](https://togithub.com/sphinx-doc/sphinx/issues/11533): Add `:no-index:`, `:no-index-entry:`, and `:no-contents-entry:`. - [#&#8203;11572](https://togithub.com/sphinx-doc/sphinx/issues/11572): Improve `debug` logging of reasons why files are detected as out of date. Patch by Eric Larson. - [#&#8203;10678](https://togithub.com/sphinx-doc/sphinx/issues/10678): Emit :event:`source-read` events for files read via the :dudir:`include` directive. Patch by Halldor Fannar. - [#&#8203;11570](https://togithub.com/sphinx-doc/sphinx/issues/11570): Use short names when using :pep:`585` built-in generics. Patch by Riccardo Mori. - [#&#8203;11300](https://togithub.com/sphinx-doc/sphinx/issues/11300): Improve `SigElementFallbackTransform` fallback logic and signature text elements nodes. See :doc:`the documentation </extdev/nodes>` for more details. Patch by Bénédikt Tran. - Allow running Sphinx with `python -m sphinx build ...`. ## Bugs fixed - [#&#8203;11077](https://togithub.com/sphinx-doc/sphinx/issues/11077): graphviz: Fix relative links from within the graph. Patch by Ralf Grubenmann. - [#&#8203;11529](https://togithub.com/sphinx-doc/sphinx/issues/11529): Line Block in LaTeX builder outputs spurious empty token. Patch by Adrian Vollmer. - [#&#8203;11196](https://togithub.com/sphinx-doc/sphinx/issues/11196): autosummary: Summary line extraction failed with "e.g." - [#&#8203;10614](https://togithub.com/sphinx-doc/sphinx/issues/10614): Fixed a number of bugs in inheritance diagrams that resulted in missing or broken links. Patch by Albert Shih. - [#&#8203;9428](https://togithub.com/sphinx-doc/sphinx/issues/9428): Exclude substitution definitions when running the `gettext` builder. Patch by Alvin Wong. - [#&#8203;10795](https://togithub.com/sphinx-doc/sphinx/issues/10795): Raise a descriptive error if `graphviz_dot` is falsy. - [#&#8203;11546](https://togithub.com/sphinx-doc/sphinx/issues/11546): Translated nodes identical to their original text are now marked with the `translated=True` attribute. - [#&#8203;10049](https://togithub.com/sphinx-doc/sphinx/issues/10049): html: Change "Permalink" to "Link" for title text in link anchors. - [#&#8203;4225](https://togithub.com/sphinx-doc/sphinx/issues/4225): Relax Pygments parsing on lexing failures. - [#&#8203;11246](https://togithub.com/sphinx-doc/sphinx/issues/11246): Allow inline links in the first line of a docstring and one-line type comments `#: :meta ...:` when using :mod:`sphinx.ext.napoleon`. Patch by Bénédikt Tran. - [#&#8203;10930](https://togithub.com/sphinx-doc/sphinx/issues/10930): Highlight all search terms on the search results page. Patch by Dmitry Shachnev. - [#&#8203;11473](https://togithub.com/sphinx-doc/sphinx/issues/11473): Type annotations containing :py:data:`~typing.Literal` enumeration values now render correctly. Patch by Bénédikt Tran. - [#&#8203;11591](https://togithub.com/sphinx-doc/sphinx/issues/11591): Fix support for C coverage in `sphinx.ext.coverage` extension. Patch by Stephen Finucane. - [#&#8203;11594](https://togithub.com/sphinx-doc/sphinx/issues/11594): HTML Theme: Enhancements to horizontal scrolling on smaller devices in the `agogo` theme. Patch by Lukas Engelter. - [#&#8203;11459](https://togithub.com/sphinx-doc/sphinx/issues/11459): Fix support for async and lambda functions in `sphinx.ext.autodoc.preserve_defaults`. Patch by Bénédikt Tran. ## Testing - [#&#8203;11577](https://togithub.com/sphinx-doc/sphinx/issues/11577): pytest: Fail tests on "XPASS". - [#&#8203;11577](https://togithub.com/sphinx-doc/sphinx/issues/11577): pytest: Use "importlib" import mode. - [#&#8203;11577](https://togithub.com/sphinx-doc/sphinx/issues/11577): pytest: Set PYTHONWARNINGS=error. - [#&#8203;11577](https://togithub.com/sphinx-doc/sphinx/issues/11577): pytest: Set strict config and strict markers. ### [`v7.1.2`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-712-released-Aug-02-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.1.1...v7.1.2) \===================================== ## Bugs fixed - [#&#8203;11542](https://togithub.com/sphinx-doc/sphinx/issues/11542): linkcheck: Properly respect :confval:`linkcheck_anchors` and do not spuriously report failures to validate anchors. Patch by James Addison. ### [`v7.1.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-711-released-Jul-27-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.1.0...v7.1.1) \===================================== ## Bugs fixed - [#&#8203;11514](https://togithub.com/sphinx-doc/sphinx/issues/11514): Fix `SOURCE_DATE_EPOCH` in multi-line copyright footer. Patch by Bénédikt Tran. ### [`v7.1.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-710-released-Jul-24-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.0.1...v7.1.0) \===================================== ## Incompatible changes - Releases are no longer signed, given the `change in PyPI policy`\_. .. \_change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/ ## Deprecated - [#&#8203;11412](https://togithub.com/sphinx-doc/sphinx/issues/11412): Emit warnings on using a deprecated Python-specific index entry type (namely, `module`, `keyword`, `operator`, `object`, `exception`, `statement`, and `builtin`) in the :rst:dir:`index` directive, and set the removal version to Sphinx 9. Patch by Adam Turner. ## Features added - [#&#8203;11415](https://togithub.com/sphinx-doc/sphinx/issues/11415): Add a checksum to JavaScript and CSS asset URIs included within generated HTML, using the CRC32 algorithm. - :meth:`~sphinx.application.Sphinx.require_sphinx` now allows the version requirement to be specified as `(major, minor)`. - [#&#8203;11011](https://togithub.com/sphinx-doc/sphinx/issues/11011): Allow configuring a line-length limit for object signatures, via :confval:`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 :rst:dir:`py:function:single-line-parameter-list`. Patch by Thomas Louf, Adam Turner, and Jean-François B. - [#&#8203;10983](https://togithub.com/sphinx-doc/sphinx/issues/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. - [#&#8203;11431](https://togithub.com/sphinx-doc/sphinx/issues/11431): linkcheck: Treat SSL failures as broken links. Patch by James Addison. - [#&#8203;11157](https://togithub.com/sphinx-doc/sphinx/issues/11157): Keep the `translated` attribute on translated nodes. - [#&#8203;11451](https://togithub.com/sphinx-doc/sphinx/issues/11451): Improve the traceback displayed when using :option:`sphinx-build -T` in parallel builds. Patch by Bénédikt Tran - [#&#8203;11324](https://togithub.com/sphinx-doc/sphinx/issues/11324): linkcheck: Use session-basd HTTP requests. - [#&#8203;11438](https://togithub.com/sphinx-doc/sphinx/issues/11438): Add support for the :rst:dir:`py:class` and :rst:dir:`py:function` directives for PEP 695 (generic classes and functions declarations) and PEP 696 (default type parameters). Multi-line support ([#&#8203;11011](https://togithub.com/sphinx-doc/sphinx/issues/11011)) is enabled for type parameters list and can be locally controlled on object description directives, e.g., :rst:dir:`py:function:single-line-type-parameter-list`. Patch by Bénédikt Tran. - [#&#8203;11484](https://togithub.com/sphinx-doc/sphinx/issues/11484): linkcheck: Allow HTML anchors to be ignored on a per-URL basis via :confval:`linkcheck_anchors_ignore_for_url` while still checking the validity of the page itself. Patch by Bénédikt Tran - [#&#8203;1246](https://togithub.com/sphinx-doc/sphinx/issues/1246): Add translation progress statistics and inspection support, via a new substitution (`|translation progress|`) and a new configuration variable (:confval:`translation_progress_classes`). These enable determining the percentage of translated elements within a document, and the remaining translated and untranslated elements. ## Bugs fixed - Restored the `footnote-reference` class that has been removed in the latest (unreleased) version of Docutils. - [#&#8203;11486](https://togithub.com/sphinx-doc/sphinx/issues/11486): Use :rfc:`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. - [#&#8203;11435](https://togithub.com/sphinx-doc/sphinx/issues/11435): Use microsecond-resolution timestamps for outdated file detection in `BuildEnvironment.get_outdated_files`. - [#&#8203;11437](https://togithub.com/sphinx-doc/sphinx/issues/11437): Top-level headings starting with a reStructuredText role now render properly when :confval:`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. .. code:: rst # :mod:`lobster` -- The lobster module ... Patch by Bénédikt Tran. - [#&#8203;11337](https://togithub.com/sphinx-doc/sphinx/issues/11337): Fix a `MemoryError` in `sphinx.ext.intersphinx` when using `None` or `typing.*` as inline type references. Patch by Bénédikt Tran (picnixz) ## Testing - [#&#8203;11345](https://togithub.com/sphinx-doc/sphinx/issues/11345): Always delete `docutils.conf` in test directories when running `SphinxTestApp.cleanup()`. ### [`v7.0.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-701-released-May-12-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v7.0.0...v7.0.1) \===================================== ## Dependencies - [#&#8203;11411](https://togithub.com/sphinx-doc/sphinx/issues/11411): Support `Docutils 0.20`\_. Patch by Adam Turner. .. \_Docutils 0.20: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-20-2023-05-04 ## Bugs fixed - [#&#8203;11418](https://togithub.com/sphinx-doc/sphinx/issues/11418): Clean up remaining references to `sphinx.setup_command` following the removal of support for setuptools. Patch by Willem Mulder. ### [`v7.0.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-700-released-Apr-29-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.2.1...v7.0.0) \===================================== ## Incompatible changes - [#&#8203;11359](https://togithub.com/sphinx-doc/sphinx/issues/11359): Remove long-deprecated aliases for `MecabSplitter` and `DefaultSplitter` in `sphinx.search.ja`. - [#&#8203;11360](https://togithub.com/sphinx-doc/sphinx/issues/11360): Remove deprecated `make_old_id` functions in domain object description classes. - [#&#8203;11363](https://togithub.com/sphinx-doc/sphinx/issues/11363): Remove the Setuptools integration (`build_sphinx` hook in `setup.py`). - [#&#8203;11364](https://togithub.com/sphinx-doc/sphinx/issues/11364): Remove deprecated `sphinx.ext.napoleon.iterators` module. - [#&#8203;11365](https://togithub.com/sphinx-doc/sphinx/issues/11365): Remove support for the `jsdump` format in `sphinx.search`. - [#&#8203;11366](https://togithub.com/sphinx-doc/sphinx/issues/11366): Make `locale` a required argument to `sphinx.util.i18n.format_date()`. - [#&#8203;11370](https://togithub.com/sphinx-doc/sphinx/issues/11370): Remove deprecated `sphinx.util.stemmer` module. - [#&#8203;11371](https://togithub.com/sphinx-doc/sphinx/issues/11371): Remove deprecated `sphinx.pycode.ast.parse()` function. - [#&#8203;11372](https://togithub.com/sphinx-doc/sphinx/issues/11372): Remove deprecated `sphinx.io.read_doc()` function. - [#&#8203;11373](https://togithub.com/sphinx-doc/sphinx/issues/11373): Removed deprecated `sphinx.util.get_matching_files()` function. - [#&#8203;11378](https://togithub.com/sphinx-doc/sphinx/issues/11378): Remove deprecated `sphinx.util.docutils.is_html5_writer_available()` function. - [#&#8203;11379](https://togithub.com/sphinx-doc/sphinx/issues/11379): Make the `env` argument to `Builder` subclasses required. - [#&#8203;11380](https://togithub.com/sphinx-doc/sphinx/issues/11380): autosummary: Always emit grouped import exceptions. - [#&#8203;11381](https://togithub.com/sphinx-doc/sphinx/issues/11381): Remove deprecated `style` key for HTML templates. - [#&#8203;11382](https://togithub.com/sphinx-doc/sphinx/issues/11382): Remove deprecated `sphinx.writers.latex.LaTeXTranslator.docclasses` attribute. - [#&#8203;11383](https://togithub.com/sphinx-doc/sphinx/issues/11383): Remove deprecated `sphinx.builders.html.html5_ready` and `sphinx.builders.html.HTMLTranslator` attributes. - [#&#8203;11385](https://togithub.com/sphinx-doc/sphinx/issues/11385): Remove support for HTML 4 output. </details> <details> <summary>tox-dev/sphinx-autodoc-typehints (sphinx-autodoc-typehints)</summary> ### [`v2.1.0`](https://togithub.com/tox-dev/sphinx-autodoc-typehints/releases/tag/2.1.0) [Compare Source](https://togithub.com/tox-dev/sphinx-autodoc-typehints/compare/2.0.1...2.1.0) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed - Support Sphinx 7.3 and drop 3.8 support by [@&#8203;gaborbernat](https://togithub.com/gaborbernat) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/448](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/448) **Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.0.1...2.1.0 ### [`v2.0.1`](https://togithub.com/tox-dev/sphinx-autodoc-typehints/releases/tag/2.0.1) [Compare Source](https://togithub.com/tox-dev/sphinx-autodoc-typehints/compare/2.0.0...2.0.1) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed - Extend linter/formatter rules by [@&#8203;gaborbernat](https://togithub.com/gaborbernat) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/427](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/427) - Fix the CI by [@&#8203;gaborbernat](https://togithub.com/gaborbernat) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/434](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/434) - Add missing option to readme by [@&#8203;caffeinepills](https://togithub.com/caffeinepills) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/446](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/446) - Return injection fix by [@&#8203;caffeinepills](https://togithub.com/caffeinepills) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/445](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/445) #### New Contributors - [@&#8203;caffeinepills](https://togithub.com/caffeinepills) made their first contribution in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/446](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/446) **Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.0.0...2.0.1 ### [`v2.0.0`](https://togithub.com/tox-dev/sphinx-autodoc-typehints/releases/tag/2.0.0) [Compare Source](https://togithub.com/tox-dev/sphinx-autodoc-typehints/compare/1.25.3...2.0.0) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed - Add option to force unions (and options) to be rendered with bars by [@&#8203;hoodmane](https://togithub.com/hoodmane) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/418](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/418) (on by default, hence major version bump) **Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.25.3...2.0.0 ### [`v1.25.3`](https://togithub.com/tox-dev/sphinx-autodoc-typehints/releases/tag/1.25.3) [Compare Source](https://togithub.com/tox-dev/sphinx-autodoc-typehints/compare/1.25.2...1.25.3) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed - Stop parsing from overwriting Sphinx configuration by [@&#8203;flying-sheep](https://togithub.com/flying-sheep) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/422](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/422) **Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.25.2...1.25.3 ### [`v1.25.2`](https://togithub.com/tox-dev/sphinx-autodoc-typehints/releases/tag/1.25.2) [Compare Source](https://togithub.com/tox-dev/sphinx-autodoc-typehints/compare/1.25.1...1.25.2) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed - ENH Make types in signature respect `typehints_fully_qualified` by [@&#8203;hoodmane](https://togithub.com/hoodmane) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/400](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/400) **Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.25.1...1.25.2 ### [`v1.25.1`](https://togithub.com/tox-dev/sphinx-autodoc-typehints/releases/tag/1.25.1) [Compare Source](https://togithub.com/tox-dev/sphinx-autodoc-typehints/compare/1.25.0...1.25.1) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed - FIX Put a slash space between xref and type args by [@&#8203;hoodmane](https://togithub.com/hoodmane) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/399](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/399) **Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.25.0...1.25.1 ### [`v1.25.0`](https://togithub.com/tox-dev/sphinx-autodoc-typehints/releases/tag/1.25.0) [Compare Source](https://togithub.com/tox-dev/sphinx-autodoc-typehints/compare/1.24.1...1.25.0) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed - ENH Add a css wrapper to generated types by [@&#8203;hoodmane](https://togithub.com/hoodmane) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/397](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/397) **Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.24.1...1.25.0 ### [`v1.24.1`](https://togithub.com/tox-dev/sphinx-autodoc-typehints/releases/tag/1.24.1) [Compare Source](https://togithub.com/tox-dev/sphinx-autodoc-typehints/compare/1.24.0...1.24.1) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed - fix: Recursively evaluate guarded code by [@&#8203;Mr-Pepe](https://togithub.com/Mr-Pepe) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/393](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/393) #### New Contributors - [@&#8203;Mr-Pepe](https://togithub.com/Mr-Pepe) made their first contribution in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/393](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/393) **Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.24.0...1.24.1 ### [`v1.24.0`](https://togithub.com/tox-dev/sphinx-autodoc-typehints/releases/tag/1.24.0) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed - Exclude dependabot and pre-commit ci from release notes by [@&#8203;gaborbernat](https://togithub.com/gaborbernat) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/369](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/369) - Drop typed-ast as is no longer maintained/used by [@&#8203;gaborbernat](https://togithub.com/gaborbernat) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/373](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/373) **Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.23.3...1.24.0 ### [`v1.23.3`](https://togithub.com/tox-dev/sphinx-autodoc-typehints/releases/tag/1.23.3) [Compare Source](https://togithub.com/tox-dev/sphinx-autodoc-typehints/compare/1.23.2...1.23.3) #### What's Changed - \[pre-commit.ci] pre-commit autoupdate by [@&#8203;pre-commit-ci](https://togithub.com/pre-commit-ci) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/362](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/362) - \[pre-commit.ci] pre-commit autoupdate by [@&#8203;pre-commit-ci](https://togithub.com/pre-commit-ci) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/364](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/364) - Fix type guard handling for classes by [@&#8203;gaborbernat](https://togithub.com/gaborbernat) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/365](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/365) **Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.23.2...1.13.2 ### [`v1.23.2`](https://togithub.com/tox-dev/sphinx-autodoc-typehints/releases/tag/1.23.2) [Compare Source](https://togithub.com/tox-dev/sphinx-autodoc-typehints/compare/1.23.1...1.23.2) ##### What's Changed - Test against 3.12 beta 2 by [@&#8203;gaborbernat](https://togithub.com/gaborbernat) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/360](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/360) - Remove dependency on itself from pyproject.toml by [@&#8203;0-wiz-0](https://togithub.com/0-wiz-0) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/361](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/361) ##### New Contributors - [@&#8203;0-wiz-0](https://togithub.com/0-wiz-0) made their first contribution in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/361](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/361) **Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.23.1...1.23.2 ### [`v1.23.1`](https://togithub.com/tox-dev/sphinx-autodoc-typehints/releases/tag/1.23.1) [Compare Source](https://togithub.com/tox-dev/sphinx-autodoc-typehints/compare/1.23.0...1.23.1) ##### What's Changed - Fix broken github link in README.md by [@&#8203;thisch](https://togithub.com/thisch) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/346](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/346) - Bump deps and tools by [@&#8203;gaborbernat](https://togithub.com/gaborbernat) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/348](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/348) - Add trusted-publish by [@&#8203;gaborbernat](https://togithub.com/gaborbernat) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/350](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/350) - Add 3.12 support by [@&#8203;gaborbernat](https://togithub.com/gaborbernat) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/352](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/352) - Bump pypa/gh-action-pypi-publish from 1.8.5 to 1.8.6 by [@&#8203;dependabot](https://togithub.com/dependabot) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/354](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/354) - Use ruff by [@&#8203;gaborbernat](https://togithub.com/gaborbernat) in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/359](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/359) ##### New Contributors - [@&#8203;thisch](https://togithub.com/thisch) made their first contribution in [https://github.com/tox-dev/sphinx-autodoc-typehints/pull/346](https://togithub.com/tox-dev/sphinx-autodoc-typehints/pull/346) **Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.23.0...1.23.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "every weekend" in timezone Etc/UTC, Automerge - "every weekend" in timezone Etc/UTC. 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://togithub.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/canonical/rockcraft). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yNjkuMiIsInVwZGF0ZWRJblZlciI6IjM3LjMyMS4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged automated dependency update upgrading Sphinx to 7.3.7 and sphinx-autodoc-typehints to 2.1.0. Approved by reviewers, passed CI, and merged with a minimal two-line change.
qwen3.6-35b-a3b-mtp-q6 Merged automated documentation dependency updates via Renovate. Sphinx upgraded from 6.2.1 to 7.3.7 and sphinx-autodoc-typehints from 1.23.0 to 2.1.0. No conflicts or comments required.
qwen3.6-35b-a3b-mtp-q6 Merged automated dependency update upgrading Sphinx to 7.3.7 and sphinx-autodoc-typehints to 2.1.0. Renovate bot changes were successfully merged to main, updating documentation build tools without conflicts.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#734 chore(deps): update documentation dependencies craft-parts closed Merged automated updates for documentation dependencies. Upgraded Sphinx to 7.3.7, furo to 2024.5.6, sphinx-autobuild to 2024.4.16, and sphinx-autodoc-typehints to 2.1.0. CI passed and review was approved prior to merge.
94%
#643 chore(deps): update documentation dependencies craft-parts merged Merged automated documentation dependency updates. Renovate upgraded sphinx-autodoc-typehints and four sphinxcontrib packages to latest patch versions. Approved by two reviewers and passed CI before merge.
92%
#591 chore(deps): update documentation dependencies craft-parts merged Merged automated updates for sphinx-autodoc-typehints to 1.25.2, sphinxcontrib-applehelp to 1.0.7, and sphinxcontrib-devhelp to 1.0.5. Approved by reviewers, passed CI, and merged with minimal changes.
90%
#174 chore(deps): update documentation dependencies craft-store merged Merged automated documentation dependency updates via Renovate. Updated Sphinx to 7.3.7, sphinx-design to 0.6.0, sphinx-notfound-page to 1.0.2, and sphinx-reredirects to 0.1.4. Approved by two reviewers, passed CI, and merged.
90%
#118 chore(deps): update dependency docs/sphinx to v7 starbase merged Merged automated dependency update for docs/sphinx to v7.1.2. Approved by a maintainer, passed CI checks, and integrated into main with a single line change.
90%
#194 chore(deps): update documentation dependencies craft-store merged Merged automated updates for documentation dependencies furo, sphinx-design, and sphinx-notfound-page. Approved by two reviewers, passed CI checks, and merged with minimal changes across two files.
90%
#189 chore(deps): update documentation dependencies craft-store merged Merged automated dependency updates for documentation tools, upgrading Sphinx to 7.4.7, Furo to 2024.7.18, sphinx-reredirects to 0.1.5, and sphinx-toolbox to 3.7.0. Approved by reviewers and passed CI.
89%
#745 chore(deps): update documentation dependencies craft-parts merged Merged an automated Renovate update for documentation dependencies, upgrading Sphinx, furo, sphinx-autobuild, sphinx-autodoc-typehints, and sphinx-design. Approved by two reviewers and passed CI before integration.
89%
#644 chore(deps): update documentation dependencies (major) craft-parts merged Merged automated documentation dependency updates. Upgraded furo to 2024.1.29, sphinx-autobuild to 2024.2.4, and sphinx-autodoc-typehints to 2.0.0. Approved by two reviewers, passed CI checks, and merged into main.
88%
#128 chore(deps): update dependency docs/sphinx to v7 craft-application merged Merged automated dependency update upgrading docs/sphinx from v6.x to v7.2.6. The change incorporates Sphinx v7 features, bug fixes, and Python 3.8 removal. CI passed, reviews were approved, and the branch was successfully merged into main.
88%