sphinx-7.1.0

[Douglas R. Reno]

New minor version

[Bruce Dubbs]

Release 7.1.0 (released Jul 24, 2023)

Incompatible changes

• Releases are no longer signed, given the 'change in PyPI policy`_.

Deprecated

• 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.

Features added

• 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).
• 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 behavior may also be controlled by options on object description directives, for example :rst:dir:'py:function:single-line-parameter-list`.
• Support for multiline copyright statements in the footer block.
• 'sphinx.util.display.status_iterator now clears the current line with ANSI control codes, rather than overprinting with space characters.
• linkcheck: Treat SSL failures as broken links.
• Keep the translated attribute on translated nodes.
• Improve the traceback displayed when using :option:'sphinx-build -T` in parallel builds.
• linkcheck: Use session-basd HTTP requests.
• 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 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`.
• 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.
• 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.
• 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.
• Use microsecond-resolution timestamps for outdated file detection in 'BuildEnvironment.get_outdated_files.
• 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.
• Fix a 'MemoryError in 'sphinx.ext.intersphinx when using 'None or 'typing.* as inline type references.

Testing

• Always delete 'docutils.conf in test directories when running 'SphinxTestApp.cleanup().

[Bruce Dubbs]

Fixed at commits

a858014f04 Update to sphinx-7.1.0 (Python module).
41a259b7a8 Update to sudo-1.9.14p3.
bf800e6cca Update to qca-2.3.7.

[Bruce Dubbs]

Milestone renamed