search

beeware / toga

A Python native, OS native GUI toolkit.
https://toga.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
4.19k stars 655 forks source link

Bump sphinx-autodoc-typehints from 2.1.0 to 2.1.1 in /core #2628

Closed dependabot[bot] closed 3 weeks ago

dependabot[bot] commented 3 weeks ago

Bumps sphinx-autodoc-typehints from 2.1.0 to 2.1.1.

Release notes

Sourced from sphinx-autodoc-typehints's releases.

2.1.1

Full Changelog: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.1.0...2.1.1

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


Dependabot compatibility score

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 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)
rmartin16 commented 3 weeks ago

FWIW, I noticed during #2252 that sphinx-autodoc-typehints was removed from the Sphinx extensions but remained in pyproject.toml. I wasn't sure if that was intentional, though.

Additionally, I noticed sphinx.ext.napoleon was still in the extensions list....but I'm not sure it's doing anything.

freakboy3742 commented 3 weeks ago

FWIW, I noticed during #2252 that sphinx-autodoc-typehints was removed from the Sphinx extensions but remained in pyproject.toml. I wasn't sure if that was intentional, though.

I hasn't been removed AFAICT - it's defined in a different location because of the odd package structure of Toga:

Additionally, I noticed sphinx.ext.napoleon was still in the extensions list....but I'm not sure it's doing anything.

Historically Toga's docstrings used a lot of Napoleon format, but that hasn't been true since we completed the audit, so we definitely shouldn't be using Napoleon at this point. PR incoming.

rmartin16 commented 3 weeks ago

FWIW, I noticed during #2252 that sphinx-autodoc-typehints was removed from the Sphinx extensions but remained in pyproject.toml. I wasn't sure if that was intentional, though.

I hasn't been removed AFAICT - it's defined in a different location because of the odd package structure of Toga:

I mean it was removed from the extensions in conf.py....so, it's dead weight right now AFAICT.

freakboy3742 commented 3 weeks ago

FWIW, I noticed during #2252 that sphinx-autodoc-typehints was removed from the Sphinx extensions but remained in pyproject.toml. I wasn't sure if that was intentional, though.

I hasn't been removed AFAICT - it's defined in a different location because of the odd package structure of Toga:

I mean it was removed from the extensions in conf.py....so, it's dead weight right now AFAICT.

Oh! You're right! We're using the builtin type hints capability, not the external plugin. I'll close this down, and merge the removal into Napoleon PR I just opened.

dependabot[bot] commented 3 weeks ago

OK, I won't notify you again about this release, but will get in touch when a new version is available. If you'd rather skip all updates until the next major or minor version, let me know by commenting @dependabot ignore this major version or @dependabot ignore this minor version. You can also ignore all major, minor, or patch releases for a dependency by adding an ignore condition with the desired update_types to your config file.

If you change your mind, just re-open this PR and I'll resolve any conflicts on it.