sphinx-autodoc-typehints
sphinx-autodoc-typehints copied to clipboard
tox-dev
Type hints support for the Sphinx autodoc extension
When type hints are shown in the signature, they are not passed through `typehints_formatter`. ## Example ``` package ├── docs │ ├── conf.py │ └── index.rst ├── my_module │ └──...
When using e.g. ``` from typing import Dict, List def test(d: Dict[str, List[str]]): pass ``` the documentation formats the type like that: **Dict[str, List[str**]], so in bold but not the...
Using Google-style docstrings with `sphinx.ext.napoleon` and `sphinx_autodoc_typehints`, I see both a **Yields:** row and a **Return type:** row in the Parameters table for generator methods. Reproducer: **docs/index.rst**: ``` rest .....
I really like this tool and have a suggestion to support a newer python feature. It would be wonderful if this tool supported https://peps.python.org/pep-0727/, enabling the entire Parameter and Return...
When trying to document a project that's using SQLAlchemy, I get the following error message: ``` WARNING: error while formatting signature for module.DatabaseModel.created_at: Handler for event 'autodoc-process-signature' threw an exception...
I'm trying to use this package when generating the API docs for https://github.com/simplistix/sybil. I've hit [an issue](https://github.com/tox-dev/sphinx-autodoc-typehints/issues/402), but it's made more tricky because the error messages give little clue as...
Currently we have this [docstring](https://github.com/unifyai/ivy/blob/main/ivy/data_classes/array/activations.py#L101-L116) ``` Parameters ---------- self input array. approximate whether to use the approximate version of the gelu function. complex_mode optional specifier for how to handle complex...
Please, see https://github.com/sphinx-doc/sphinx/issues/11460 first. So, after having read that, you should know that someone suggested me to open the same issue here. I don't know if this is related to...
As of version 3.3, Sphinx provides the functionality for a dictionary called `autodoc_type_aliases` in which the user can explicitly put type aliases that they do not want the autodoc to...
I'm trying to get a nice formatting for my method, which has several overloads, using literals with various enum variants. This is the code: Click to expand the code snippet...
