sphinx-8.2.0 (Python module)

[Bruce Dubbs]

New point version.

[Joe Locash]

8.2.0 adds the requirement of the roman-numerals-py module.

[Bruce Dubbs]

Release 8.2.0 (released Feb 18, 2025)

Dependencies

• Drop Python 3.10 support.

Incompatible changes

• Remove the internal and undocumented has_equations data from the :py:class:`!MathDomain` domain. The undocumented :py:meth:`!MathDomain.has_equations` method now unconditionally returns True. These are replaced by the has_maths_elements key of the page context dict.
• HTML output for sequences of keys in the :rst:role:`kbd` role no longer uses a <kbd class="kbd compound"> element to wrap the keys and separators, but places them directly in the relevant parent node. This means that CSS rulesets targeting kbd.compound or .kbd.compound will no longer have any effect.

Deprecated

• Deprecate the SingleHTMLBuilder.fix_refuris method.
• Un-deprecate sphinx.util.import_object.

Features added

• Add a new duplicate_declaration warning type, with duplicate_declaration.c and duplicate_declaration.cpp subtypes.
• linkcode: Allow extensions to add support for a domain by defining the keys that should be present.
• Add a class option to the :rst:dir:`autosummary` directive.
• Napoleon: Unify the type preprocessing logic to allow Google-style docstrings to use the optional and default keywords.
• Implement the :rst:role:`kbd role as a SphinxRole`.
• Enable colour by default in when running on CI.
• Allow supressing warnings from the :rst:dir:`toctree` directive when a glob pattern doesn't match any documents, via the new toc.empty_glob warning sub-type.
• Add the new autodoc.mocked_object warnings sub-type.
• autodoc: Use :file:.pyi type stub files to auto-document native modules.
• Enable configuration of trailing commas in multi-line signatures in the Python and Javascript domains, via the new :confval:python_trailing_comma_in_multi_line_signatures and :confval:javascript_trailing_comma_in_multi_line_signatures configuration options.
• Rename the :rst:dir:`math directive's nowrap` option to :rst:dir:`math:no-wrap`.
• Added the option to disable the use of type comments in via the new :confval:autodoc_use_type_comments option, which defaults to True for backwards compatibility. The default will change to False in Sphinx 10.
• Add the new ref.any warnings sub-type to allow suppressing the ambiguous 'any' cross-reference warning.
• The Python and JavaScript module directives now support the :no-index-entry: option.
• autodoc: Allow directives to use :no-index-entry: and include the :no-index: and :no-index-entry: options within :confval:autodoc_default_options.
• Add support for short signatures in autosummary.
• Change the signature prefix for abstract methods in the Python domain to *abstractmethod* from *abstract*.
• Support the :abstract: option for classes, methods, and properties in the Python domain.
• Add the :ref:collapsible <collapsible-admonitions> option to admonition directives.
• Add :rst:dir:`inheritance-diagram:include-subclasses` option to the :rst:dir:`inheritance-diagram` directive.
• autodoc: Add support for :confval:python_display_short_literal_types.
• Always print the full context when Sphinx encounters an internal error.
• Introduce the :rst:role:`py:deco` role to cross-reference decorator functions and methods in the Python domain.
• Add the :confval:intersphinx_resolve_self option to resolve an intersphinx reference to the current project.
• Add ability to skip a particular section using the no-search class.
• Remove hardcoding from handling :class:~sphinx.addnodes.productionlist nodes in all writers, to improve flexibility.
• Use misc.highlighting_failure subtype for Pygments unknown lexers.
• Insert abbreviation nodes (hover text) for positional- and keyword-only separators in Python signatures.
• Add the :mod:sphinx.ext.apidoc extension, to automate API documentation generation from Python modules.

Bugs fixed

• autosummary: Respect an empty module all.
• HTML Search: use Map to store per-file term scores.
• LaTeX docs: pdflatex index creation may fail for index entries in French. See :confval:latex_use_xindy.
• LaTeX: fix a typo from v7.4.0 in a default for \sphinxboxsetup.
• HTML Search: check that query terms exist as properties in term indices before accessing them.
• linkcheck: match redirect URIs against :confval:linkcheck_ignore by overriding session-level requests.get_redirect_target.
• viewcode: Fix issue where import paths differ from the directory structure.
• autodoc: fix detection of class methods implemented in C.
• Always copy static files when building, regardless of whether any documents have changed since the previous build.
• autodoc: fix ordering of members when using groupwise for :confval:autodoc_member_order. Class methods are now rendered before static methods, which themselves are rendered before regular methods and attributes.
• Avoid rendering a trailing comma in C and C++ multi-line signatures.
• autodoc: Fix resolution for pathlib types.
• autodoc: Correctly handle multiple inheritance.
• Properly convert command-line overrides for Boolean types.
• Use the correct indentation for continuation lines in :rst:dir:`productionlist` directives.
• Fix parsing of PEP 695 functions with return annotations.

Testing

• Correctness fixup for test_html_multi_line_copyright.

[Bruce Dubbs]

Fixed at commits

a3b2c9cbb1 Update to sphinx-8.2.0 (Python module).
6eef5f7668 Update to sentry-sdk-2.22.0 (Python module).