sphinx-autodoc-typehints
sphinx-autodoc-typehints copied to clipboard
tox-dev
Type hints support for the Sphinx autodoc extension
Hi, I've created a dummy repo highlighting my issue. There is a python module called `mymodule` and a `README.md` explaining my full step by step issue... https://github.com/henryJack/sphinx_issue/blob/master/README.md ### Problem -...
**Is your feature request related to a problem? Please describe.** autodoc-typehint adds type hints to attributes of normal classes but not to attributes of attrs classes. **Describe the solution you'd...
**Describe the bug** The sphinx autosummary extension turns off the `typing.TYPE_CHECKING` flag used by the sphinx-autodoc-typehints extension to do conditional imports of annotation types (among other things), you may want...
Parameters can be optional with a default value. ```python some_function(some_variable: some_type = default_value) ```` Is there any possibility to show this in the variable description? For Example this could be...
README does not explain whether this extension is still needed with the current versions of Sphinx
The build-in extension `sphinx.ext.autodoc` contains the parameter [`autodoc_typehints`](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_typehints) with option `description` since the version 3.0. It seems that this configuration option makes `sphinx-autodoc-typehints` obsolete. Am I right? In any way...
The change introduced in https://github.com/tox-dev/sphinx-autodoc-typehints/commit/ccc75d244d0f4452048f80fc73e39a34a4eefc00 renamed the extra `type-comments` to `type-comment` (no `s`), causing mismatched warnings when installing with pip: ```shell pip install "sphinx-autodoc-typehints[type_comments]=1.19" [...] WARNING: sphinx-autodoc-typehints 1.19.4 does not...
Since https://github.com/tox-dev/sphinx-autodoc-typehints/pull/422/ has been merged , the function documentation contains the `rst_prolog` option text. The [`rst_prolog` option](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-rst_prolog) is automatically inserted at the beginning of each source file read. I currently...
It would be great being able to ignore warnings like `WARNING: Cannot resolve forward reference in type annotations of`… (In reference to https://github.com/sphinx-doc/sphinx/issues/10219#issuecomment-1481200927) The reason is that some warnings are...
I've run into a situation where `sphinx-autodoc-typehints` is inserting the rtype signature without creating space between rtype and the previous paragraph so it isn't being rendered correctly in the final...
