Skip to content

Commit 0f427e2

Browse files
authored
build(deps): update sphinx-autodoc-typehints requirement from <2.4,>=2.2.2 to >=2.2.2,<2.5 (#344)
Updates the requirements on [sphinx-autodoc-typehints](https://github.com/tox-dev/sphinx-autodoc-typehints) to permit the latest version. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/tox-dev/sphinx-autodoc-typehints/releases">sphinx-autodoc-typehints's releases</a>.</em></p> <blockquote> <h2>Fix broken link in README</h2> <!-- raw HTML omitted --> <p><strong>Full Changelog</strong>: <a href="https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.4.3...2.4.4">https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.4.3...2.4.4</a></p> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/tox-dev/sphinx-autodoc-typehints/blob/main/CHANGELOG.md">sphinx-autodoc-typehints's changelog</a>.</em></p> <blockquote> <h1>Changelog</h1> <h2>1.22</h2> <ul> <li>Allow Sphinx explicitly to write in parallel.</li> <li>Fixed crash when documenting ParamSpecArgs</li> </ul> <h2>1.21.7</h2> <ul> <li> <p>Fixed a bug where if a class has an attribute and a constructor argument with the same name, the constructor argument type would be rendered incorrectly (issue 308)</p> </li> <li> <p>Fixed napoleon handling of numpy docstrings with no specified return type.</p> </li> </ul> <h2>1.21.6</h2> <ul> <li>Fix a <code>Field list ends without a blank line</code> warning (issue 305).</li> </ul> <h2>1.21.5</h2> <ul> <li>More robust determination of rtype location / fix issue 302</li> </ul> <h2>1.21.4</h2> <ul> <li>Improvements to the location of the return type</li> </ul> <h2>1.21.3</h2> <ul> <li>Use format_annotation to render class attribute type annotations</li> </ul> <h2>1.21.2</h2> <ul> <li>Fix overloads support</li> </ul> <h2>1.21.1</h2> <ul> <li>Fix spacing between <code>:rtype:</code> and directives</li> </ul> <h2>1.21</h2> <ul> <li>Handle types from types module</li> <li>If module is _io, use io instead</li> <li>Put rtype before examples or usage section</li> <li>Remove redundant return type for attributes</li> <li>Handle collections.abc.Callable as well as typing.Callable</li> <li>Put Literal args in code blocks</li> </ul> <h2>1.20.2</h2> <ul> <li>Fix Optional role to be data.</li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/4b19ed2c51b0163e1c25339589078a3581aa407c"><code>4b19ed2</code></a> Link to API directly</li> <li><a href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/51f6cb37bf99c07e52b2a06a5a3abd47f742fd2b"><code>51f6cb3</code></a> Fix broken link in README</li> <li><a href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/658bc809b4a8594e09ebbb9d699beec59ff956f4"><code>658bc80</code></a> Update README.md</li> <li><a href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/ec010d0b436ea798569b92fdb494995f5f09dc9b"><code>ec010d0</code></a> Improve the CI (<a href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/485">#485</a>)</li> <li><a href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/bdf5359350300d82822232fe88a8910bb2568a53"><code>bdf5359</code></a> [pre-commit.ci] pre-commit autoupdate (<a href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/484">#484</a>)</li> <li><a href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/8a90d5725be01ecfdc77d55b1c44038f7dce6bce"><code>8a90d57</code></a> Fix placement of return type when there is a doctest (<a href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/482">#482</a>)</li> <li><a href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/8c8c73d9794eb84c1639ee6c6c4758bf5880460c"><code>8c8c73d</code></a> [pre-commit.ci] pre-commit autoupdate (<a href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/478">#478</a>)</li> <li><a href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/475c49e447f57a74787c413a0e4e46a893a75e8f"><code>475c49e</code></a> Fix upload-artifact@v4</li> <li><a href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/f15864efb7b2b8e56665c792a7d69bb8706d7950"><code>f15864e</code></a> Drop 3.9 support</li> <li><a href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/852239613cd976874723c41a1b74ba4ec6b542c4"><code>8522396</code></a> Fix CI and add 3.13 as target with dep/tool upgrades</li> <li>Additional commits viewable in <a href="https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.2.2...2.4.4">compare view</a></li> </ul> </details> <br /> 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>
2 parents 2e7d7d7 + 5efbcc3 commit 0f427e2

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

requirements/documentation.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ furo>=2024
22
matplotlib>=3.8,<4
33
myst-parser[linkify]>=2
44
sphinx-autobuild>=2021
5-
sphinx-autodoc-typehints>=2.2.2,<2.4
5+
sphinx-autodoc-typehints>=2.2.2,<2.5
66
sphinx-click>=5
77
sphinx-copybutton<1
88
sphinx-design>=0.5,<1

0 commit comments

Comments
 (0)