Skip to content

Commit

Permalink
Bump sphinx-autodoc-typehints from 1.25.3 to 2.2.3 (#404)
Browse files Browse the repository at this point in the history
Bumps
[sphinx-autodoc-typehints](https://github.com/tox-dev/sphinx-autodoc-typehints)
from 1.25.3 to 2.2.3.
<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.2.3</h2>
<!-- raw HTML omitted -->
<h2>What's Changed</h2>
<ul>
<li>Fix mypy errors due to unneeded type ignores by <a
href="https://github.com/hoodmane"><code>@​hoodmane</code></a> in <a
href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/pull/469">tox-dev/sphinx-autodoc-typehints#469</a></li>
<li>Fix rendering when docstring starst with a directive by <a
href="https://github.com/hoodmane"><code>@​hoodmane</code></a> in <a
href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/pull/468">tox-dev/sphinx-autodoc-typehints#468</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.2.2...2.2.3">https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.2.2...2.2.3</a></p>
<h2>2.2.2</h2>
<!-- raw HTML omitted -->
<h2>What's Changed</h2>
<ul>
<li>Fix for Issue <a
href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/384">#384</a>:
typehints_defaults = &quot;braces-after&quot; fails for a multiline
<code>:param:</code> entry by <a
href="https://github.com/tikuma-lsuhsc"><code>@​tikuma-lsuhsc</code></a>
in <a
href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/pull/464">tox-dev/sphinx-autodoc-typehints#464</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.2.1...2.2.2">https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.2.1...2.2.2</a></p>
<h2>2.2.1</h2>
<!-- raw HTML omitted -->
<h2>What's Changed</h2>
<ul>
<li>Fix issue <a
href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/462">#462</a>
and another alias processing bug by <a
href="https://github.com/tikuma-lsuhsc"><code>@​tikuma-lsuhsc</code></a>
in <a
href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/pull/463">tox-dev/sphinx-autodoc-typehints#463</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.2.0...2.2.1">https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.2.0...2.2.1</a></p>
<h2>2.2.0</h2>
<!-- raw HTML omitted -->
<h2>What's Changed</h2>
<ul>
<li>Support autodoc_type_aliases configuration by <a
href="https://github.com/tikuma-lsuhsc"><code>@​tikuma-lsuhsc</code></a>
in <a
href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/pull/459">tox-dev/sphinx-autodoc-typehints#459</a></li>
</ul>
<h2>New Contributors</h2>
<ul>
<li><a
href="https://github.com/tikuma-lsuhsc"><code>@​tikuma-lsuhsc</code></a>
made their first contribution in <a
href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/pull/459">tox-dev/sphinx-autodoc-typehints#459</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.1.1...2.2.0">https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.1.1...2.2.0</a></p>
<h2>2.1.1</h2>
<!-- raw HTML omitted -->
<p><strong>Full Changelog</strong>: <a
href="https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.1.0...2.1.1">https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.1.0...2.1.1</a></p>
<h2>2.1.0</h2>
<!-- raw HTML omitted -->
<h2>What's Changed</h2>
<!-- 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/d38f8f7d3406bbeea9e3134b1e55ca2e0654eaf7"><code>d38f8f7</code></a>
[pre-commit.ci] pre-commit autoupdate (<a
href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/466">#466</a>)</li>
<li><a
href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/a427536cdb38ec356de2c42cecdaa41daa8cdd86"><code>a427536</code></a>
Fix rendering when docstring starst with a directive (<a
href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/468">#468</a>)</li>
<li><a
href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/fdad0d76bb296e1e36ade156166d2ca0454fdbf6"><code>fdad0d7</code></a>
Fix mypy errors due to unneeded type ignores (<a
href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/469">#469</a>)</li>
<li><a
href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/df669800eef5da7e952a24b84501846694b27101"><code>df66980</code></a>
[pre-commit.ci] pre-commit autoupdate (<a
href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/465">#465</a>)</li>
<li><a
href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/ea99f28598fe8cc4181c5bcf64b295e310ff4caa"><code>ea99f28</code></a>
Fix for Issue <a
href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/384">#384</a>:
typehints_defaults = &quot;braces-after&quot; fails for a
multiline...</li>
<li><a
href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/0435d0762d3000c488326bfe70c67669fc299972"><code>0435d07</code></a>
Fix issue <a
href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/462">#462</a>
and another alias processing bug (<a
href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/463">#463</a>)</li>
<li><a
href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/fb240eace36a9755ec4fc0a3cb77abe2f05fe717"><code>fb240ea</code></a>
Support autodoc_type_aliases configuration (<a
href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/459">#459</a>)</li>
<li><a
href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/41b290030643d971a97af1504943fc792814be8c"><code>41b2900</code></a>
Bump pypa/gh-action-pypi-publish from 1.8.14 to 1.9.0 (<a
href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/460">#460</a>)</li>
<li><a
href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/047ac44b31d488a665fbbba481115ec73441f886"><code>047ac44</code></a>
[pre-commit.ci] pre-commit autoupdate (<a
href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/461">#461</a>)</li>
<li><a
href="https://github.com/tox-dev/sphinx-autodoc-typehints/commit/fd0a0c6c437e0808d33c96bd157b117af3842d86"><code>fd0a0c6</code></a>
[pre-commit.ci] pre-commit autoupdate (<a
href="https://redirect.github.com/tox-dev/sphinx-autodoc-typehints/issues/458">#458</a>)</li>
<li>Additional commits viewable in <a
href="https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.25.3...2.2.3">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=sphinx-autodoc-typehints&package-manager=pip&previous-version=1.25.3&new-version=2.2.3)](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>
  • Loading branch information
JWCook authored Aug 4, 2024
2 parents 82b176e + 78fd6e8 commit 512ee18
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 21 deletions.
62 changes: 42 additions & 20 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ furo = {optional=true, version='^2024.7'}
linkify-it-py = {optional=true, version='^2.0'}
myst-parser = {optional=true, version='^3.0'}
sphinx = {optional=true, version='^7.4'}
sphinx-autodoc-typehints = {optional=true, version='^1.17'}
sphinx-autodoc-typehints = {optional=true, version='^2.2'}
sphinx-copybutton = {optional=true, version='>=0.5'}
sphinx-design = {optional=true, version='>=0.2'}
sphinxcontrib-apidoc = {optional=true, version='^0.5'}
Expand Down

0 comments on commit 512ee18

Please sign in to comment.