chore(deps): update dependency sphinx to >=8,<8.3 #477
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
>=8,<8.2->>=8,<8.3Release Notes
sphinx-doc/sphinx (sphinx)
v8.2.0Compare Source
==============================
Dependencies
Incompatible changes
has_equationsdatafrom the :py:class:
!MathDomaindomain.The undocumented :py:meth:
!MathDomain.has_equationsmethodnow unconditionally returns
True.These are replaced by the
has_maths_elementskey of the page context dict.Patch by Adam Turner.
kbdroleno longer uses a
<kbd class="kbd compound">element to wrapthe keys and separators, but places them directly in the relevant parent node.
This means that CSS rulesets targeting
kbd.compoundor.kbd.compoundwill no longer have any effect.
Patch by Adam Turner.
Deprecated
SingleHTMLBuilder.fix_refurismethod.Patch by James Addison.
sphinx.util.import_object.Patch by Matthias Geier.
Features added
duplicate_declarationwarning type,with
duplicate_declaration.candduplicate_declaration.cppsubtypes.Patch by Julien Lecomte and Adam Turner.
the keys that should be present.
Patch by Nicolas Peugnet.
classoption to the :rst:dir:autosummarydirective.Patch by Tim Hoffmann.
Google-style docstrings to use the optional and default keywords.
Patch by Chris Barrick.
kbdrole as aSphinxRole.Patch by Adam Turner.
Patch by Adam Turner.
toctreedirectivewhen a glob pattern doesn't match any documents,
via the new
toc.empty_globwarning sub-type.Patch by Slawek Figiel.
autodoc.mocked_objectwarnings sub-type.Patch by Cyril Roelandt.
.pyitype stub filesto auto-document native modules.
Patch by Adam Turner, partially based on work by Allie Fitter.
in the Python and Javascript domains, via the new
:confval:
python_trailing_comma_in_multi_line_signaturesand:confval:
javascript_trailing_comma_in_multi_line_signaturesconfiguration options.
mathdirective'snowrapoptionto :rst:dir:
math:no-wrap.Patch by Adam Turner.
via the new :confval:
autodoc_use_type_commentsoption,which defaults to
Truefor backwards compatibility.The default will change to
Falsein Sphinx 10.Patch by Adam Turner.
ref.anywarnings sub-typeto allow suppressing the ambiguous 'any' cross-reference warning.
Patch by Simão Afonso and Adam Turner.
the
:no-index-entry:option.Patch by Adam Turner.
:no-index-entry:and include the
:no-index:and:no-index-entry:options within:confval:
autodoc_default_options.Patch by Jonny Saunders and Adam Turner.
Patch by Tim Hoffmann.
in the Python domain to abstractmethod from abstract.
Patch by Adam Turner.
:abstract:option forclasses, methods, and properties in the Python domain.
Patch by Adam Turner.
collapsible <collapsible-admonitions>optionto admonition directives.
Patch by Chris Sewell.
inheritance-diagram:include-subclassesoption tothe :rst:dir:
inheritance-diagramdirective.Patch by Walter Dörwald.
python_display_short_literal_types.Patch by Bénédikt Tran and Adam Turner.
Patch by Kevin Deldycke and Adam Turner.
py:decorole to cross-reference decoratorfunctions and methods in the Python domain.
Patch by Adam Turner.
intersphinx_resolve_selfoptionto resolve an intersphinx reference to the current project.
Patch by Jakob Lykke Andersen and Adam Turner.
no-searchclass.Patch by Will Lachance.
~sphinx.addnodes.productionlistnodes in all writers, to improve flexibility.
Patch by Adam Turner.
misc.highlighting_failuresubtype for Pygments unknown lexers.Patch by Bart Kamphorst.
separators in Python signatures.
Patch by Adam Turner.
sphinx.ext.apidocextension,to automate API documentation generation from Python modules.
Patch by Chris Sewell and Adam Turner.
Bugs fixed
__all__.Patch by Valentin Pratz
Mapto store per-file term scores.Patch by James Addison
pdflatexindex creation may fail for index entriesin French. See :confval:
latex_use_xindy.Patch by Jean-François B.
\sphinxboxsetup.Patch by Jean-François B.
term indices before accessing them.
linkcheck_ignorebyoverriding session-level
requests.get_redirect_target.structure.
Patch by Ben Egan and Adam Turner.
Patch by Bénédikt Tran.
any documents have changed since the previous build.
Patch by Adam Turner.
groupwisefor :confval:
autodoc_member_order. Class methods are now renderedbefore static methods, which themselves are rendered before regular
methods and attributes.
Patch by Bénédikt Tran.
pathlibtypes.Patch by Adam Turner.
Patch by Pavel Holica
Patch by Adam Turner.
in :rst:dir:
productionlistdirectives.Patch by Adam Turner.
Patch by Bénédikt Tran. Initial work by Arash Badie-Modiri.
Testing
test_html_multi_line_copyright.Patch by Colin Watson, applied by James Addison.
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.