IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Close #6361: autodoc: Add autodoc_typehints to suppress typehints from signature

Browse Source
This commit is contained in:
Takeshi KOMIYA
2019-05-26 00:20:44 +09:00
parent 6e795a05be
commit 0ea380eddd
5 changed files with 85 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/usage/extensions/autodoc.rst
View File

@@ -431,6 +431,16 @@ There are also config values that you can set:
This config value only requires to declare the top-level modules that
should be mocked.
.. confval:: autodoc_typehints
This value controls how to represents typehints. The setting takes the
following values:
* ``'signature'`` -- Show typehints as its signature (default)
* ``'none'`` -- Do not show typehints
.. versionadded: 2.1
.. confval:: autodoc_warningiserror
This value controls the behavior of :option:`sphinx-build -W` during