Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update sphinx-autodoc-typehints requirement from <2.3,>=1.24 to >=1.24,<2.4 #26

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Sep 2, 2024

Updates the requirements on sphinx-autodoc-typehints to permit the latest version.

Release notes

Sourced from sphinx-autodoc-typehints's releases.

2.3.0

What's Changed

Full Changelog: tox-dev/sphinx-autodoc-typehints@2.2.3...2.3.0

Changelog

Sourced from sphinx-autodoc-typehints's changelog.

Changelog

1.22

  • Allow Sphinx explicitly to write in parallel.
  • Fixed crash when documenting ParamSpecArgs

1.21.7

  • 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)

  • Fixed napoleon handling of numpy docstrings with no specified return type.

1.21.6

  • Fix a Field list ends without a blank line warning (issue 305).

1.21.5

  • More robust determination of rtype location / fix issue 302

1.21.4

  • Improvements to the location of the return type

1.21.3

  • Use format_annotation to render class attribute type annotations

1.21.2

  • Fix overloads support

1.21.1

  • Fix spacing between :rtype: and directives

1.21

  • Handle types from types module
  • If module is _io, use io instead
  • Put rtype before examples or usage section
  • Remove redundant return type for attributes
  • Handle collections.abc.Callable as well as typing.Callable
  • Put Literal args in code blocks

1.20.2

  • Fix Optional role to be data.

... (truncated)

Commits
  • 6d91418 Add module name rewrite configuration option (#474)
  • c8be42f [pre-commit.ci] pre-commit autoupdate (#470)
  • d38f8f7 [pre-commit.ci] pre-commit autoupdate (#466)
  • a427536 Fix rendering when docstring starst with a directive (#468)
  • fdad0d7 Fix mypy errors due to unneeded type ignores (#469)
  • df66980 [pre-commit.ci] pre-commit autoupdate (#465)
  • ea99f28 Fix for Issue #384: typehints_defaults = "braces-after" fails for a multiline...
  • 0435d07 Fix issue #462 and another alias processing bug (#463)
  • fb240ea Support autodoc_type_aliases configuration (#459)
  • 41b2900 Bump pypa/gh-action-pypi-publish from 1.8.14 to 1.9.0 (#460)
  • Additional commits viewable in compare view

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 commands and options

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)

Updates the requirements on [sphinx-autodoc-typehints](https://github.com/tox-dev/sphinx-autodoc-typehints) to permit the latest version.
- [Release notes](https://github.com/tox-dev/sphinx-autodoc-typehints/releases)
- [Changelog](https://github.com/tox-dev/sphinx-autodoc-typehints/blob/main/CHANGELOG.md)
- [Commits](tox-dev/sphinx-autodoc-typehints@1.24.0...2.3.0)

---
updated-dependencies:
- dependency-name: sphinx-autodoc-typehints
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Sep 2, 2024
Copy link
Contributor Author

dependabot bot commented on behalf of github Sep 9, 2024

Superseded by #27.

@dependabot dependabot bot closed this Sep 9, 2024
@dependabot dependabot bot deleted the dependabot/pip/sphinx-autodoc-typehints-gte-1.24-and-lt-2.4 branch September 9, 2024 03:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants