build(deps): bump sphinx from 5.1.1 to 5.2.3
Bumps sphinx from 5.1.1 to 5.2.3.
Release notes
Sourced from sphinx's releases.
v5.2.3
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v5.2.2
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v5.2.1
Changelog: https://www.sphinx-doc.org/en/master/changes.html
v5.2.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog
Sourced from sphinx's changelog.
Release 5.2.3 (released Sep 30, 2022)
- #10878: Fix base64 image embedding in
sphinx.ext.imgmath- #10886: Add
:nocontentsentry:flag and global domain table of contents entry control option. Patch by Adam TurnerRelease 5.2.2 (released Sep 27, 2022)
- #10872: Restore link targets for autodoc modules to the top of content. Patch by Dominic Davis-Foster.
Release 5.2.1 (released Sep 25, 2022)
Bugs fixed
- #10861: Always normalise the
pycon3lexer topycon.- Fix using
sphinx.ext.autosummarywith modules containing titles in the module-level docstring.Release 5.2.0.post0 (released Sep 24, 2022)
- Recreated source tarballs for Debian maintainers.
Release 5.2.0 (released Sep 24, 2022)
Dependencies
- #10356: Sphinx now uses declarative metadata with
pyproject.tomlto create packages, using PyPA'sflitproject as a build backend. Patch by Adam Turner.Deprecated
- #10843: Support for HTML 4 output. Patch by Adam Turner.
Features added
... (truncated)
Commits
cbb19d6Bump to 5.2.3 final650f63bFiner grained control over domain ToC entries (#10886)6627618imgmath: Fix embed mode (#10878)a651e6bBump to 5.2.2 final335f335Restore anchor links to top of module docstring19c2783Correct error in release date for Sphinx 5.2.1635540cRestore anchor links to top of module docstring89b4f14Fix mypy violations for v0.981 (#10875)e0dbbc5Bump to 5.2.1 final15c1cbaFix error in changelog for Sphinx 5.2.0- Additional commits viewable in compare view
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
@dependabot rebasewill rebase this PR@dependabot recreatewill recreate this PR, overwriting any edits that have been made to it@dependabot mergewill merge this PR after your CI passes on it@dependabot squash and mergewill squash and merge this PR after your CI passes on it@dependabot cancel mergewill cancel a previously requested merge and block automerging@dependabot reopenwill reopen this PR if it is closed@dependabot closewill close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually@dependabot ignore this major versionwill close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this minor versionwill close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this dependencywill close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
It would be great if this PR could be landed (and the docs generated with the newer version of Sphinx).
Specifically due to this change in Sphinx, which would make reading the API reference easier:
#6316, #10804: Add domain objects to the table of contents. Patch by Adam Turner
PS: Consider changing the API reference theme to Furo, which has significantly better API documentation presentation; although, I'll admit I'm biased as the author of that theme. The migration is usually quite simple (you'll want to replace sphinx-rtd-theme/alabaster with furo).