Skip to content

Commit ad4f3cf

Browse files
authored
build(deps): update sphinx-autodoc-typehints requirement from <2.5,>=2.2.2 to >=2.2.2,<2.6 (#348)
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>2.5.0</h2> <!-- raw HTML omitted --> <h2>What's Changed</h2> <ul> <li>Fix the type checker by <a href="https://github.com/gaborbernat"><code>@​gaborbernat</code></a> in <a href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/pull/493">tox-dev/sphinx-autodoc-typehints#493</a></li> <li>Apply typehints_formatter to signature by <a href="https://github.com/Priyansh121096"><code>@​Priyansh121096</code></a> in <a href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/pull/494">tox-dev/sphinx-autodoc-typehints#494</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/Priyansh121096"><code>@​Priyansh121096</code></a> made their first contribution in <a href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/pull/494">tox-dev/sphinx-autodoc-typehints#494</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.4.4...2.5.0">https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.4.4...2.5.0</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/244af2f0c18944a4cb3e69c86c886c6dd80aca78"><code>244af2f</code></a> Apply typehints_formatter to signature (<a href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/494">#494</a>)</li> <li><a href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/e17a669da15e9cdd8728a9290dadee8dcb59c95e"><code>e17a669</code></a> [pre-commit.ci] pre-commit autoupdate (<a href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/492">#492</a>)</li> <li><a href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/e24bf5ec675692b8f632407afc35de4e5d24e9df"><code>e24bf5e</code></a> Bump pypa/gh-action-pypi-publish from 1.10.2 to 1.10.3 (<a href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/491">#491</a>)</li> <li><a href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/07c27518fde4e18493e8a2a8ea766da25412bead"><code>07c2751</code></a> Fix the type checker (<a href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/493">#493</a>)</li> <li><a href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/70b7c4fe21a01ae6e74005612ae2a121946ee206"><code>70b7c4f</code></a> [pre-commit.ci] pre-commit autoupdate (<a href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/490">#490</a>)</li> <li><a href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/73293b9a578f36d8a0abe97b1f985e7ca4023c7c"><code>73293b9</code></a> Bump pypa/gh-action-pypi-publish from 1.10.1 to 1.10.2 (<a href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/488">#488</a>)</li> <li><a href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/c632481355ddfa3ca867d9af4358e1a2c37da03a"><code>c632481</code></a> [pre-commit.ci] pre-commit autoupdate (<a href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/489">#489</a>)</li> <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>Additional commits viewable in <a href="https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.2.2...2.5.0">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 5b2f269 + a873eb7 commit ad4f3cf

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.5
5+
sphinx-autodoc-typehints>=2.2.2,<2.6
66
sphinx-click>=5
77
sphinx-copybutton<1
88
sphinx-design>=0.5,<1

0 commit comments

Comments
 (0)