chore(deps): update dependency sphinx to v7
This MR contains the following updates:
| Package | Update | Change |
|---|---|---|
| sphinx (changelog) | major |
==6.2.1 -> ==7.1.2
|
Release Notes
sphinx-doc/sphinx (sphinx)
v7.1.2
=====================================
Bugs fixed
-
#11542: linkcheck: Properly respect :confval:
linkcheck_anchorsand do not spuriously report failures to validate anchors. Patch by James Addison.
v7.1.1
=====================================
Bugs fixed
-
#11514: Fix
SOURCE_DATE_EPOCHin multi-line copyright footer. Patch by Bénédikt Tran.
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
-
#11412: Emit warnings on using a deprecated Python-specific index entry type
(namely,
module,keyword,operator,object,exception,statement, andbuiltin) in the :rst:dir:indexdirective, and set the removal version to Sphinx 9. Patch by Adam Turner.
Features added
- #11415: Add a checksum to JavaScript and CSS asset URIs included within generated HTML, using the CRC32 algorithm.
- :meth:
~sphinx.application.Sphinx.require_sphinxnow allows the version requirement to be specified as(major, minor). -
#11011: Allow configuring a line-length limit for object signatures, via
:confval:
maximum_signature_line_lengthand 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. - #10983: Support for multiline copyright statements in the footer block. Patch by Stefanie Molin
-
sphinx.util.display.status_iteratornow clears the current line with ANSI control codes, rather than overprinting with space characters. - #11431: linkcheck: Treat SSL failures as broken links. Patch by James Addison.
-
#11157: Keep the
translatedattribute on translated nodes. -
#11451: Improve the traceback displayed when using :option:
sphinx-build -Tin parallel builds. Patch by Bénédikt Tran - #11324: linkcheck: Use session-basd HTTP requests.
-
#11438: Add support for the :rst:dir:
py:classand :rst:dir:py:functiondirectives for PEP 695 (generic classes and functions declarations) and PEP 696 (default type parameters). Multi-line support (#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. -
#11484: linkcheck: Allow HTML anchors to be ignored on a per-URL basis
via :confval:
linkcheck_anchors_ignore_for_urlwhile still checking the validity of the page itself. Patch by Bénédikt Tran -
#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-referenceclass that has been removed in the latest (unreleased) version of Docutils. -
#11486: Use :rfc:
8081font file MIME types in the EPUB builder. Using the correct MIME type will prevent warnings fromepubcheckand will generate a valid EPUB. -
#11435: Use microsecond-resolution timestamps for outdated file detection in
BuildEnvironment.get_outdated_files. -
#11437: Top-level headings starting with a reStructuredText role now render properly when :confval:
rst_prologis 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.
-
#11337: Fix a
MemoryErrorinsphinx.ext.intersphinxwhen usingNoneortyping.*as inline type references. Patch by Bénédikt Tran (picnixz)
Testing
-
#11345: Always delete
docutils.confin test directories when runningSphinxTestApp.cleanup().
v7.0.1
=====================================
Dependencies
-
#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
-
#11418: Clean up remaining references to
sphinx.setup_commandfollowing the removal of support for setuptools. Patch by Willem Mulder.
v7.0.0
=====================================
Incompatible changes
-
#11359: Remove long-deprecated aliases for
MecabSplitterandDefaultSplitterinsphinx.search.ja. -
#11360: Remove deprecated
make_old_idfunctions in domain object description classes. -
#11363: Remove the Setuptools integration (
build_sphinxhook insetup.py). -
#11364: Remove deprecated
sphinx.ext.napoleon.iteratorsmodule. -
#11365: Remove support for the
jsdumpformat insphinx.search. -
#11366: Make
localea required argument tosphinx.util.i18n.format_date(). -
#11370: Remove deprecated
sphinx.util.stemmermodule. -
#11371: Remove deprecated
sphinx.pycode.ast.parse()function. -
#11372: Remove deprecated
sphinx.io.read_doc()function. -
#11373: Removed deprecated
sphinx.util.get_matching_files()function. -
#11378: Remove deprecated
sphinx.util.docutils.is_html5_writer_available()function. -
#11379: Make the
envargument toBuildersubclasses required. - #11380: autosummary: Always emit grouped import exceptions.
-
#11381: Remove deprecated
stylekey for HTML templates. -
#11382: Remove deprecated
sphinx.writers.latex.LaTeXTranslator.docclassesattribute. -
#11383: Remove deprecated
sphinx.builders.html.html5_readyandsphinx.builders.html.HTMLTranslatorattributes. - #11385: Remove support for HTML 4 output.
Configuration
-
If you want to rebase/retry this MR, check this box
This MR has been generated by Renovate Bot.