CHORE: Bump the doc group with 3 updates

[dependabot]

Bumps the doc group with 3 updates: sphinx, ansys-sphinx-theme[autoapi,changelog] and sphinx-autodoc-typehints.

Updates sphinx from 8.1.3 to 8.2.1

Release notes

Sourced from sphinx's releases.

Sphinx 8.2.1

Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html

Sphinx 8.2.0

Changelog: https://www.sphinx-doc.org/en/master/changes/8.2.html

Dependencies

• #13000: Drop Python 3.10 support.

Incompatible changes

• #13044: Remove the internal and undocumented has_equations data from the MathDomain domain. The undocumented MathDomain.has_equations method now unconditionally returns True. These are replaced by the has_maths_elements key of the page context dict. Patch by Adam Turner.
• #13227: HTML output for sequences of keys in the 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. Patch by Adam Turner.

Deprecated

• #13037: Deprecate the SingleHTMLBuilder.fix_refuris method. Patch by James Addison.
• #13083, #13330: Un-deprecate sphinx.util.import_object. Patch by Matthias Geier.

Features added

• #13173: Add a new duplicate_declaration warning type, with duplicate_declaration.c and duplicate_declaration.cpp subtypes. Patch by Julien Lecomte and Adam Turner.
• #11824: linkcode: Allow extensions to add support for a domain by defining the keys that should be present. Patch by Nicolas Peugnet.
• #13144: Add a class option to the autosummary directive. Patch by Tim Hoffmann.
• #13146: Napoleon: Unify the type preprocessing logic to allow Google-style docstrings to use the optional and default keywords. Patch by Chris Barrick.

... (truncated)

Changelog

Sourced from sphinx's changelog.

Release 8.2.1 (released Feb 21, 2025)

Bugs fixed

• #13367: Correct spelling of highlighting_failure in warning sub-type. Patch by Bart Kamphorst.
• #13377: Restore support for using sphinx.testing.path paths with sphinx.testing.fixtures. Patch by Kazuya Takei.
• #13380: viewcode: Fix importing modules more than once. Patch by Dave Hoese.
• #13382: Napoleon: Use the right valid types for configuration values. Patch by Adam Turner.
• 13376: Fix copying assets from a relative :confval:html_static_path entry. Patch by Adam Turner.

Release 8.2.0 (released Feb 18, 2025)

Dependencies

• #13000: Drop Python 3.10 support.

Incompatible changes

• #13044: 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. Patch by Adam Turner.
• #13227: 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. Patch by Adam Turner.

Deprecated

• #13037: Deprecate the SingleHTMLBuilder.fix_refuris method. Patch by James Addison.
• #13083, #13330: Un-deprecate sphinx.util.import_object. Patch by Matthias Geier.

... (truncated)

Commits

• 0215a73 Bump to 8.2.1 final
• 53b7913 Remove background colours from (un)translated classes
• 58e64d4 Fix _relative_path() for unresolved paths
• 1a3d1de Add missing CHANGES entry
• d847d73 Bump Ruff to 0.9.7
• 7ba7628 Napoleon: Fix valid types for configuration values (#13382)
• 8ef0708 Fix viewcode extension importing modules more than once (#13380)
• 7e1bf28 Restore support for sphinx.testing.path paths in ``sphinx.testing.fixture...
• d099161 Revert "Mark autodoc singledispatchmethod tests as expected failures" (#13381)
• ba3c729 Switch transifex workflow trigger from 'push' to 'pull_request'
• Additional commits viewable in compare view

Updates ansys-sphinx-theme[autoapi,changelog] from 1.3.1 to 1.3.2

Commits

• 83e9d8f chore: updating CHANGELOG for v1.3.2
• 8bea3fa release: bump version 1.3.2
• 213e54b fix: alignment and styles for primary sidebar (#621)
• f021509 fix: prettier pre-commit hook (#627)
• 3999092 Fix: whatsnew config instructions (#619)
• See full diff in compare view

Updates sphinx-autodoc-typehints from 3.0.1 to 3.1.0

Release notes

Sourced from sphinx-autodoc-typehints's releases.

3.1.0

What's Changed

• Support Sphinx 8.2.0 - drop 3.10 support because Sphinx does by @​b-kamphorst in tox-dev/sphinx-autodoc-typehints#525

New Contributors

• @​b-kamphorst made their first contribution in tox-dev/sphinx-autodoc-typehints#525

Full Changelog: tox-dev/sphinx-autodoc-typehints@3.0.1...3.1.0

Commits

• ca5fcc0 Support Sphinx 8.2.0 - drop 3.10 support because Sphinx does (#525)
• f09eb89 [pre-commit.ci] pre-commit autoupdate (#524)
• 6ffdf92 [pre-commit.ci] pre-commit autoupdate (#522)
• fd427dc [pre-commit.ci] pre-commit autoupdate (#521)
• bfa7f43 [pre-commit.ci] pre-commit autoupdate (#520)
• da5feae Bump pypa/gh-action-pypi-publish from 1.12.3 to 1.12.4 (#519)
• 5a6f798 [pre-commit.ci] pre-commit autoupdate (#518)
• See full diff in compare view

Most Recent Ignore Conditions Applied to This Pull Request

Dependency Name	Ignore Conditions
sphinx	[>= 7.0.a, < 7.1]
sphinx-autodoc-typehints	[< 1.24, > 1.23.3]

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 rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore <dependency name> major version will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself)
• @dependabot ignore <dependency name> minor version will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself)
• @dependabot ignore <dependency name> will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself)
• @dependabot unignore <dependency name> will remove all of the ignore conditions of the specified dependency
• @dependabot unignore <dependency name> <ignore condition> will remove the ignore condition of the specified dependency and ignore conditions

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.28%. Comparing base (dad2a2c) to head (27312df).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1103      +/-   ##
==========================================
+ Coverage   79.74%   87.28%   +7.53%     
==========================================
  Files          43       43              
  Lines        2854     2854              
==========================================
+ Hits         2276     2491     +215     
+ Misses        578      363     -215