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

requirements: update sphinx-autodoc-typehints requirement from <1.13.0 to <1.15.0 #2278

Merged

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jan 6, 2022

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

Changelog

Sourced from sphinx-autodoc-typehints's changelog.

1.14.0

  • Added typehints_defaults config option allowing to automatically annotate parameter defaults.

1.13.1

  • Fixed NewType inserts a reference as first argument instead of a string

1.13.0

  • Dropped Python 3.6 support
  • Python 3.10 support
  • Normalize async functions properly
  • Allow py310 style annotations (PEP-563)

1.12.0

  • Dropped Python 3.5 support
  • Added the simplify_optional_unions config option (PR by tillhainbach)
  • Fixed indentation of multiline strings (PR by Yuxin Wu)

1.11.1

  • Changed formatting of None to point to the Python stdlib docs (PR by Dominic Davis-Foster)
  • Updated special dataclass handling (PR by Lihu Ben-Ezri-Ravin)

1.11.0

  • Dropped support for Sphinx < 3.0
  • Added support for alternative parameter names (arg, argument, parameter)
  • Fixed import path for Signature (PR by Matthew Treinish)
  • Fixed TypeError when formatting a parametrized typing.IO annotation
  • Fixed data class displaying a return type in its __init__() method

1.10.3

  • Fixed TypeError (or wrong rendered class name) when an annotation is a generic class that has a name property

1.10.2

  • Fixed inner classes missing their parent class name(s) when rendered

1.10.1

  • Fixed KeyError when encountering mocked annotations (autodoc_mock_imports)

1.10.0

  • Rewrote the annotation formatting logic (fixes Python 3.5.2 compatibility regressions and an AttributeError regression introduced in v1.9.0)

... (truncated)

Commits

You can trigger a rebase of this PR 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 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.0.0...1.14.0)

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

Signed-off-by: dependabot[bot] <[email protected]>
@github-actions
Copy link

github-actions bot commented Jan 6, 2022

This PR causes the following changes to the html docs (ubuntu-latest-3.7-x64):

No differences!

...

See CI logs for the full diff.

@jvesely
Copy link
Collaborator

jvesely commented Jan 7, 2022

@kmantel, is this OK to merge given there are no differences in generated docs?

@kmantel
Copy link
Collaborator

kmantel commented Jan 7, 2022

@kmantel, is this OK to merge given there are no differences in generated docs?
Yes, I don't see why not

@jvesely
Copy link
Collaborator

jvesely commented Jan 7, 2022

@dependabot rebase

@jvesely
Copy link
Collaborator

jvesely commented Jan 7, 2022

@dependabot squash and merge

@jvesely
Copy link
Collaborator

jvesely commented Jan 7, 2022

@dependabot rebase

@jvesely
Copy link
Collaborator

jvesely commented Jan 7, 2022

@dependabot cancel merge

@jvesely
Copy link
Collaborator

jvesely commented Jan 7, 2022

@dependabot rebase

@jvesely
Copy link
Collaborator

jvesely commented Jan 7, 2022

@dependabot recreate

@github-actions
Copy link

github-actions bot commented Jan 8, 2022

This PR causes the following changes to the html docs (ubuntu-latest-3.7-x64):

No differences!

...

See CI logs for the full diff.

@coveralls
Copy link

Coverage Status

Coverage increased (+0.0003%) to 84.328% when pulling 65773b3 on dependabot/pip/devel/sphinx-autodoc-typehints-lt-1.15.0 into da4ecb7 on devel.

@jvesely
Copy link
Collaborator

jvesely commented Jan 8, 2022

@dependabot squash and merge

@dependabot dependabot bot merged commit 544c1ec into devel Jan 8, 2022
@dependabot dependabot bot deleted the dependabot/pip/devel/sphinx-autodoc-typehints-lt-1.15.0 branch January 8, 2022 01:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deps Dependency update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants