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.15.0 to <1.16.0 #2283

Merged

Conversation

dependabot[bot]
Copy link
Contributor

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

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

Changelog

Sourced from sphinx-autodoc-typehints's changelog.

1.15.1

  • Fix fully_qualified should be typehints_fully_qualified

1.15.0

  • Resolve type guard imports before evaluating annotations for objects
  • Remove set_type_checking_flag flag as this is now done by default
  • Fix crash when the inspect module returns an invalid python syntax source
  • Made formatting function configurable using the option typehints_formatter

1.14.1

  • Fixed normalize_source_lines() messing with the indentation of methods with decorators that have parameters starting with def.
  • Handle ValueError or TypeError being raised when signature of an object cannot be determined
  • Fix KeyError being thrown when argument is not documented (e.g. cls argument for class methods, and self for methods)

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)

... (truncated)

Commits
  • d770c69 Fix fully_qualified should be typehints_fully_qualified (#204)
  • 87759d4 Release 1.15.0
  • 27555dd Remove set_type_checking flag (#202)
  • e2e780d Configurable formatter (#171)
  • 91c9f86 Resolve type guard imports (#201)
  • 1e25828 Fix crash when inspect moduel returns invalid Python code
  • 6b86a6a Local methods are only troublesome for methods
  • d5ed402 Remove extra space in warning
  • d2d2d23 Simplify code for process signature
  • b2f26ce Update CHANGELOG.md
  • Additional commits viewable in compare view

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.15.1)

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

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added the deps Dependency update label Jan 10, 2022
@github-actions
Copy link

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

diff -r docs-base/.buildinfo docs-head/.buildinfo
3c3
< config: 93a36d7daeeffc980fdbe13b5661e43b
---
> config: 2756124a1a258cfc1eedcf79d651812e

...

See CI logs for the full diff.

@jvesely
Copy link
Collaborator

jvesely commented Jan 11, 2022

@dependabot squash and merge

@dependabot dependabot bot merged commit 59a7c47 into devel Jan 11, 2022
@dependabot dependabot bot deleted the dependabot/pip/devel/sphinx-autodoc-typehints-lt-1.16.0 branch January 11, 2022 15:05
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.

None yet

1 participant