diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2022-01-01 19:02:09 +0900 |
|---|---|---|
| committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2022-01-01 19:02:09 +0900 |
| commit | 6ee3dd196813ca7bbf91105d0d6e563ea1fcd202 (patch) | |
| tree | 27dd861f5752e3306ef2b0de7dd21e9ce43d88a0 /doc/usage | |
| parent | d62220676d38f8d588fb59f92c3169385e94ad00 (diff) | |
| parent | b22134dcd35c9cffd5c8fe5a3f5224fcb3d3741f (diff) | |
| download | sphinx-git-6ee3dd196813ca7bbf91105d0d6e563ea1fcd202.tar.gz | |
Merge branch '4.x'
Diffstat (limited to 'doc/usage')
| -rw-r--r-- | doc/usage/extensions/autodoc.rst | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/doc/usage/extensions/autodoc.rst b/doc/usage/extensions/autodoc.rst index 29551c648..df588e91d 100644 --- a/doc/usage/extensions/autodoc.rst +++ b/doc/usage/extensions/autodoc.rst @@ -662,10 +662,15 @@ 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 +.. confval:: autodoc_typehints_format - If True, the leading module names of typehints of function signatures are - removed (ex. ``io.StringIO`` -> ``StringIO``). Defaults to False. + This value controls the format of typehints. The setting takes the + following values: + + * ``'fully-qualified'`` -- Show the module name and its name of typehints + (default) + * ``'short'`` -- Suppress the leading module names of the typehints + (ex. ``io.StringIO`` -> ``StringIO``) .. versionadded:: 4.4 |