Skip to content

Commit fab9d7f

Browse files
Build(deps): Bump sphinx from 8.1.3 to 8.2.0 (#676)
Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 8.1.3 to 8.2.0. <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.0</h2> <p>Changelog: <a href="https://www.sphinx-doc.org/en/master/changes.html">https://www.sphinx-doc.org/en/master/changes.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>&lt;kbd class=&quot;kbd compound&quot;&gt;</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> <li><a href="https://redirect.github.com/sphinx-doc/sphinx/issues/13227">#13227</a>: Implement the <code>kbd</code> role as a <code>SphinxRole</code>. Patch by Adam Turner.</li> <li><a href="https://redirect.github.com/sphinx-doc/sphinx/issues/13065">#13065</a>: Enable colour by default in when running on CI.</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/master/CHANGES.rst">sphinx's changelog</a>.</em></p> <blockquote> <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>&lt;kbd class=&quot;kbd compound&quot;&gt;</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 :rst:dir:<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> <li><a href="https://redirect.github.com/sphinx-doc/sphinx/issues/13227">#13227</a>: Implement the :rst:role:<code>kbd</code> role as a <code>SphinxRole</code>. Patch by Adam Turner.</li> <li><a href="https://redirect.github.com/sphinx-doc/sphinx/issues/13065">#13065</a>: Enable colour by default in when running on CI. Patch by Adam Turner.</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/78bb5a18436d4d5def5134063f31078b2d39c939"><code>78bb5a1</code></a> Bump to 8.2.0 final</li> <li><a href="https://github.com/sphinx-doc/sphinx/commit/2f8c1ddc63f3165babdd83a83ba1266ff726d488"><code>2f8c1dd</code></a> Mark autodoc singledispatchmethod tests as expected failures</li> <li><a href="https://github.com/sphinx-doc/sphinx/commit/03ee6b09cefcb1335919ca1f7bf5043fa52ff104"><code>03ee6b0</code></a> Require flit-core 3.10 for Python 3.14</li> <li><a href="https://github.com/sphinx-doc/sphinx/commit/3c324a6707bfb5056d7d3f9578c69e67afecea51"><code>3c324a6</code></a> [bot]: Update message catalogues (<a href="https://redirect.github.com/sphinx-doc/sphinx/issues/13021">#13021</a>)</li> <li><a href="https://github.com/sphinx-doc/sphinx/commit/b1dc2062c9b05192903ff0c7d3734471a72e005b"><code>b1dc206</code></a> Emend typo in CHANGES</li> <li><a href="https://github.com/sphinx-doc/sphinx/commit/23cd5d0565dc8d54fe100ccb07f6f25f961f2eb0"><code>23cd5d0</code></a> Bump version</li> <li><a href="https://github.com/sphinx-doc/sphinx/commit/684ed565022eed53d50092678905201a04f461d9"><code>684ed56</code></a> Bump to 8.2.0 candidate 2</li> <li><a href="https://github.com/sphinx-doc/sphinx/commit/7e73faac4513ca4b0afe94e5020148d5de39d131"><code>7e73faa</code></a> Define environment variables in the transifex workflow</li> <li><a href="https://github.com/sphinx-doc/sphinx/commit/552f6148ab0383fde7be7a8d947be31e301669eb"><code>552f614</code></a> Run the transifex workflow on changes to relevant files</li> <li><a href="https://github.com/sphinx-doc/sphinx/commit/179e24252b1a6c9ad6b9415402eda9a9f09d2b67"><code>179e242</code></a> Add the <code>sphinx.ext.apidoc</code> extension (<a href="https://redirect.github.com/sphinx-doc/sphinx/issues/13333">#13333</a>)</li> <li>Additional commits viewable in <a href="https://github.com/sphinx-doc/sphinx/compare/v8.1.3...v8.2.0">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=sphinx&package-manager=pip&previous-version=8.1.3&new-version=8.2.0)](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 5eb4cc8 commit fab9d7f

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

requirements/doc.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
sphinx==8.1.3
1+
sphinx==8.2.0
22
pygments>=2.1
33
aiohttp-theme==0.1.7

0 commit comments

Comments
 (0)