Add a new extension: sphinx.ext.autodoc.typehints

This commit is contained in:
Takeshi KOMIYA
2020-01-12 01:54:57 +09:00
parent 2e22e96061
commit 5397664d42
6 changed files with 191 additions and 0 deletions

View File

@@ -39,6 +39,10 @@ Features added
* #2755: autodoc: Support type_comment style (ex. ``# type: (str) -> str``)
annotation (python3.8+ or `typed_ast <https://github.com/python/typed_ast>`_
is required)
* #6418: autodoc: Add a new extension ``sphinx.ext.autodoc.typehints``. It shows
typehints as object description if ``autodoc_typehints = "description"`` set.
This is an experimental extension and it will be integrated into autodoc core
in Sphinx-3.0
* SphinxTranslator now calls visitor/departure method for super node class if
visitor/departure method for original node class not found
* #6418: Add new event: :event:`object-description-transform`