[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [docs/furo](https://togithub.com/pradyunsg/furo) | `==2023.7.26` -> `==2023.9.10` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | | [docs/sphinx](https://togithub.com/sphinx-doc/sphinx) ([changelog](https://www.sphinx-doc.org/en/master/changes.html)) | `>=7.1,<7.2` -> `>=7.2,<7.3` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>pradyunsg/furo (docs/furo)</summary> ### [`v2023.9.10`](https://togithub.com/pradyunsg/furo/compare/2023.08.19...2023.09.10) [Compare Source](https://togithub.com/pradyunsg/furo/compare/2023.08.19...2023.09.10) ### [`v2023.8.19`](https://togithub.com/pradyunsg/furo/compare/2023.08.17...2023.08.19) [Compare Source](https://togithub.com/pradyunsg/furo/compare/2023.08.17...2023.08.19) ### [`v2023.8.17`](https://togithub.com/pradyunsg/furo/compare/2023.07.26...2023.08.17) [Compare Source](https://togithub.com/pradyunsg/furo/compare/2023.07.26...2023.08.17) </details> <details> <summary>sphinx-doc/sphinx (docs/sphinx)</summary> ### [`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. </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/craft-providers). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi45Ny4xIiwidXBkYXRlZEluVmVyIjoiMzYuOTcuMSIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->