diff options
author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2021-12-11 04:59:23 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-12-11 04:59:23 +0300 |
commit | d3162d1ff2e24f4d190ed3ba5bc76d72c781f791 (patch) | |
tree | 4152eba4ec90f434583dcf25cfb1e8ca23f269fb /doc | |
parent | b5ee2d09fcfe005b483a18b8d15623c4e7861606 (diff) | |
parent | c71ff1cd21ce796f871adef54e8a53c0eaa9e53a (diff) |
Merge pull request #9931 from tk0miya/9075_autodoc_unqualified_typehints
Close #9075: autodoc: Add a config variable autodoc_unqualified_typehints
Diffstat (limited to 'doc')
-rw-r--r-- | doc/usage/extensions/autodoc.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/usage/extensions/autodoc.rst b/doc/usage/extensions/autodoc.rst index 5ac3cd171..dab09c92c 100644 --- a/doc/usage/extensions/autodoc.rst +++ b/doc/usage/extensions/autodoc.rst @@ -662,6 +662,13 @@ There are also config values that you can set: .. __: https://mypy.readthedocs.io/en/latest/kinds_of_types.html#type-aliases .. versionadded:: 3.3 +.. confval:: autodoc_unqualified_typehints + + If True, the leading module names of typehints of function signatures (ex. + ``io.StringIO`` -> ``StringIO``). Defaults to False. + + .. versionadded:: 4.4 + .. confval:: autodoc_preserve_defaults If True, the default argument values of functions will be not evaluated on |