sphinx-autodoc-typehints
sphinx-autodoc-typehints copied to clipboard
tox-dev
Type hints support for the Sphinx autodoc extension
This worked fine is version 1.14.1 and earlier but starting in 1.15.0 I get TypeError: ABCMeta is not subscriptable. I have code that's something like this: ``` from typing import...
Warnings/errors with generic messages do not provide context for what in the code caused the error. Specifically, I ran into it here: https://github.com/tox-dev/sphinx-autodoc-typehints/blob/bf27befb610426838d1f2926e470815c47cc8ab8/src/sphinx_autodoc_typehints/__init__.py#L343 I changed that log to also print...
Given function signature ```python def grid_archive_heatmap(archive, ax=None, ... ) ``` and setting `typehints_defaults = "comma" ("braces", "braces-after")` . `sphinx-autodoc-typehints` does not correctly add a "default=" clause for the argument `ax`...
Hello there, first of all thank you very much for this project which you share with us! I started the module recently and it worked fantastically in many cases! Thanks...
We encountered the following error while setting a return type which mocked in Sphinx config using a custom `Mock` object ``` Handler for event 'autodoc-process-docstring' threw an exception (exception: getattr():...
Properties introspected by typehints are decorated with a "return type" clause. This can take up a lot of space and talking about "return type" for a property/attribute is not even...
[I am maintaining some Python API documentation for Ethereum and Web3.py ecosystem](https://smart-contracts-for-testing.readthedocs.io/). To improve the readability of the API documentation, I stumbled upon on your very useful `sphinx-autodoc-typehints` plugin. IMHO...
The Sphinx output changes depending on if [PEP 604](https://www.python.org/dev/peps/pep-0604/) Union syntax is used. It’s *not* about `from __future__ import annotations`, it’s about actually *using the syntax*! Even on versions <...
**Describe the bug** I have some nested NamedTuple definitions and `sphinx_autodoc_typehints` cannot resolve them. Without `sphinx_autodoc_typehints`, Sphinx has no issues generating a suitable documentation. In addition, PyCharm with its code...
Hello, i'm currently trying to use sphinx-autodoc-typehints to create a nice documentation for my project pyage (https://github.com/Timtam/pyage). I do have an issue however. When i'm annotating a method like this:...
