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 to 2.3.0 #103

Closed

Conversation

pyup-bot
Copy link
Collaborator

This PR updates sphinx-autodoc-typehints from 1.10.3 to 2.3.0.

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.

1.20.1

- Fixed default options not displaying for parameters without type hints.

1.20

- Use hatchling instead of setuptools
- Add support for typing.ParamSpec
- Allow star prefixes for parameter names in docstring

1.19.2

- Fix incorrect domain used for collections.abc.Callable.

1.19.1

- Fix bug for recursive type alias.

1.19.0

- Support for CPython 3.11, no longer adds `Optional` when the argument is default per
[recommendation from PEP-484](https://github.com/tox-dev/sphinx-autodoc-typehints/pull/247).

1.18.3

- Support and require `nptyping>=2.1.2`

1.18.2

- Support and require `nptyping>=2.1.1`

1.18.1

- Fix mocked module import not working when used as guarded import

1.18.0

- Support and require `nptyping>=2`
- Handle `UnionType`

1.17.1

- Mark it as requiring `nptyping<2`

1.17.0

- Add `typehints_use_rtype` option
- Handles `TypeError` when getting source code via inspect

1.16.0

- Add support for type subscriptions with multiple elements, where one or more elements are tuples; e.g.,
`nptyping.NDArray[(Any, ...), nptyping.Float]`
- Fix bug for arbitrary types accepting singleton subscriptions; e.g., `nptyping.Float[64]`
- Resolve forward references
- Expand and better handle `TypeVar`
- Add intershpinx reference link for `...` to `Ellipsis` (as is just an alias)

1.15.3

- Prevents reaching inner blocks that contains `if TYPE_CHECKING`

1.15.2

- Log a warning instead of crashing when a type guard import fails to resolve
- When resolving type guard imports if the target module does not have source code (such is the case for C-extension
modules) do nothing instead of crashing

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)
- Fixed `TypeError` when formatting a parametrized `typing.IO` annotation
- Fixed data class displaying a return type in its `__init__()` method
Links

@pyup-bot pyup-bot added the dependency update Specifies pyup.io dependency updates label Aug 29, 2024
@pyup-bot
Copy link
Collaborator Author

pyup-bot commented Sep 7, 2024

Closing this in favor of #112

@pyup-bot pyup-bot closed this Sep 7, 2024
@vbe0201 vbe0201 deleted the pyup-update-sphinx-autodoc-typehints-1.10.3-to-2.3.0 branch September 7, 2024 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependency update Specifies pyup.io dependency updates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant