Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/sphinx-doc/sphinx.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2021-12-02 19:28:10 +0300
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2021-12-03 12:05:49 +0300
commitc71ff1cd21ce796f871adef54e8a53c0eaa9e53a (patch)
tree152af7e4d0be3572694937a3b0b0e54f746156ba /CHANGES
parent5aa6cbbca85ddc3fe5dd93d45a7cf5073db2f334 (diff)
Close #9075: autodoc: Add a config variable autodoc_unqualified_typehints
If autodoc_unqualified_typehints feature enabled, autodoc suppresses the leading module names of typehints of function signatures (ex. `io.StringIO` -> `StringIO`)
Diffstat (limited to 'CHANGES')
-rw-r--r--CHANGES3
1 files changed, 3 insertions, 0 deletions
diff --git a/CHANGES b/CHANGES
index 9ce12b924..727ff22fe 100644
--- a/CHANGES
+++ b/CHANGES
@@ -13,6 +13,9 @@ Deprecated
Features added
--------------
+* #9075: autodoc: Add a config variable :confval:`autodoc_unqualified_typehints`
+ to suppress the leading module names of typehints of function signatures (ex.
+ ``io.StringIO`` -> ``StringIO``)
* #9831: Autosummary now documents only the members specified in a module's
``__all__`` attribute if :confval:`autosummary_ignore_module_all` is set to
``False``. The default behaviour is unchanged. Autogen also now supports