-
Notifications
You must be signed in to change notification settings - Fork 6
Commit 462fc20
authored
Bump sphinx from 8.1.3 to 8.2.1 in /docs (#130)
Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 8.1.3 to
8.2.1.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/sphinx-doc/sphinx/releases">sphinx's
releases</a>.</em></p>
<blockquote>
<h2>Sphinx 8.2.1</h2>
<p>Changelog: <a
href="https://www.sphinx-doc.org/en/master/changes/8.2.html">https://www.sphinx-doc.org/en/master/changes/8.2.html</a></p>
<h2>Sphinx 8.2.0</h2>
<p>Changelog: <a
href="https://www.sphinx-doc.org/en/master/changes/8.2.html">https://www.sphinx-doc.org/en/master/changes/8.2.html</a></p>
<h2>Dependencies</h2>
<ul>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13000">#13000</a>:
Drop Python 3.10 support.</li>
</ul>
<h2>Incompatible changes</h2>
<ul>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13044">#13044</a>:
Remove the internal and undocumented <code>has_equations</code> data
from the <code>MathDomain</code> domain.
The undocumented <code>MathDomain.has_equations</code> method
now unconditionally returns <code>True</code>.
These are replaced by the <code>has_maths_elements</code> key of the
page context dict.
Patch by Adam Turner.</li>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13227">#13227</a>:
HTML output for sequences of keys in the <code>kbd</code> role
no longer uses a <code><kbd class="kbd compound"></code>
element to wrap
the keys and separators, but places them directly in the relevant parent
node.
This means that CSS rulesets targeting <code>kbd.compound</code> or
<code>.kbd.compound</code>
will no longer have any effect.
Patch by Adam Turner.</li>
</ul>
<h2>Deprecated</h2>
<ul>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13037">#13037</a>:
Deprecate the <code>SingleHTMLBuilder.fix_refuris</code> method.
Patch by James Addison.</li>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13083">#13083</a>,
<a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13330">#13330</a>:
Un-deprecate <code>sphinx.util.import_object</code>.
Patch by Matthias Geier.</li>
</ul>
<h2>Features added</h2>
<ul>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13173">#13173</a>:
Add a new <code>duplicate_declaration</code> warning type,
with <code>duplicate_declaration.c</code> and
<code>duplicate_declaration.cpp</code> subtypes.
Patch by Julien Lecomte and Adam Turner.</li>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/11824">#11824</a>:
linkcode: Allow extensions to add support for a domain by defining
the keys that should be present.
Patch by Nicolas Peugnet.</li>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13144">#13144</a>:
Add a <code>class</code> option to the <code>autosummary</code>
directive.
Patch by Tim Hoffmann.</li>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13146">#13146</a>:
Napoleon: Unify the type preprocessing logic to allow
Google-style docstrings to use the optional and default keywords.
Patch by Chris Barrick.</li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/sphinx-doc/sphinx/blob/v8.2.1/CHANGES.rst">sphinx's
changelog</a>.</em></p>
<blockquote>
<h1>Release 8.2.1 (released Feb 21, 2025)</h1>
<h2>Bugs fixed</h2>
<ul>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13367">#13367</a>:
Correct spelling of <code>highlighting_failure</code> in warning
sub-type.
Patch by Bart Kamphorst.</li>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13377">#13377</a>:
Restore support for using <code>sphinx.testing.path</code> paths with
<code>sphinx.testing.fixtures</code>.
Patch by Kazuya Takei.</li>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13380">#13380</a>:
viewcode: Fix importing modules more than once.
Patch by Dave Hoese.</li>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13382">#13382</a>:
Napoleon: Use the right valid types for configuration values.
Patch by Adam Turner.</li>
<li>13376: Fix copying assets from a relative
:confval:<code>html_static_path</code> entry.
Patch by Adam Turner.</li>
</ul>
<h1>Release 8.2.0 (released Feb 18, 2025)</h1>
<h2>Dependencies</h2>
<ul>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13000">#13000</a>:
Drop Python 3.10 support.</li>
</ul>
<h2>Incompatible changes</h2>
<ul>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13044">#13044</a>:
Remove the internal and undocumented <code>has_equations</code> data
from the :py:class:<code>!MathDomain</code> domain.
The undocumented :py:meth:<code>!MathDomain.has_equations</code> method
now unconditionally returns <code>True</code>.
These are replaced by the <code>has_maths_elements</code> key of the
page context dict.
Patch by Adam Turner.</li>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13227">#13227</a>:
HTML output for sequences of keys in the :rst:role:<code>kbd</code> role
no longer uses a <code><kbd class="kbd compound"></code>
element to wrap
the keys and separators, but places them directly in the relevant parent
node.
This means that CSS rulesets targeting <code>kbd.compound</code> or
<code>.kbd.compound</code>
will no longer have any effect.
Patch by Adam Turner.</li>
</ul>
<h2>Deprecated</h2>
<ul>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13037">#13037</a>:
Deprecate the <code>SingleHTMLBuilder.fix_refuris</code> method.
Patch by James Addison.</li>
<li><a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13083">#13083</a>,
<a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13330">#13330</a>:
Un-deprecate <code>sphinx.util.import_object</code>.
Patch by Matthias Geier.</li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/0215a73cbfd9326c5fd54160da277112fd6435c9"><code>0215a73</code></a>
Bump to 8.2.1 final</li>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/53b79139f60d9b994060a64c1c40b419c2565c0c"><code>53b7913</code></a>
Remove background colours from (un)translated classes</li>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/58e64d401635c516937ebd553594a1ee31b903b5"><code>58e64d4</code></a>
Fix <code>_relative_path()</code> for unresolved paths</li>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/1a3d1def223a1967bb7af4029f5cae7859f9f518"><code>1a3d1de</code></a>
Add missing CHANGES entry</li>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/d847d736ec75cd9becbde68a5c7069ceca2b3852"><code>d847d73</code></a>
Bump Ruff to 0.9.7</li>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/7ba762870f83175848ff1cd94a1b783ecde57f9a"><code>7ba7628</code></a>
Napoleon: Fix valid types for configuration values (<a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13382">#13382</a>)</li>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/8ef07089eeb3082f23338f18519d8cc96fd38b43"><code>8ef0708</code></a>
Fix viewcode extension importing modules more than once (<a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13380">#13380</a>)</li>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/7e1bf28c285de88c150426b7059b17e641d35bc4"><code>7e1bf28</code></a>
Restore support for <code>sphinx.testing.path</code> paths in
``sphinx.testing.fixture...</li>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/d0991618788e51c2f8cf3544fa7b42fe54cf0f74"><code>d099161</code></a>
Revert "Mark autodoc singledispatchmethod tests as expected
failures" (<a
href="https://redirect.github.com/sphinx-doc/sphinx/issues/13381">#13381</a>)</li>
<li><a
href="https://github.com/sphinx-doc/sphinx/commit/ba3c729b70c1e1cf378431078629eb612b8000e8"><code>ba3c729</code></a>
Switch transifex workflow trigger from 'push' to 'pull_request'</li>
<li>Additional commits viewable in <a
href="https://github.com/sphinx-doc/sphinx/compare/v8.1.3...v8.2.1">compare
view</a></li>
</ul>
</details>
<br />
[](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
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-automerge-start)
[//]: # (dependabot-automerge-end)
---
<details>
<summary>Dependabot commands and options</summary>
<br />
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 this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)
</details>
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>1 parent 9e23cb7 commit 462fc20Copy full SHA for 462fc20
1 file changed
+1
-1
lines changeddocs/requirements.txt
Copy file name to clipboard+1-1
Original file line number | Diff line number | Diff line change | |
---|---|---|---|
| |||
1 | 1 |
| |
2 |
| - | |
| 2 | + | |
3 | 3 |
|
0 commit comments