diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2021-04-11 21:35:47 +0900 |
|---|---|---|
| committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2021-04-11 21:35:47 +0900 |
| commit | d09747f225e4960636a126b98b0d4cb1c79bf288 (patch) | |
| tree | 0619c67de3969f398c2353d01705a22ec52d2131 /sphinx/ext/napoleon | |
| parent | 42a1bcf2c7a177f6d337a09ef5fd90c2fad69a75 (diff) | |
| download | sphinx-git-d09747f225e4960636a126b98b0d4cb1c79bf288.tar.gz | |
doc: Add docs for napoleon_preprocess_types
Diffstat (limited to 'sphinx/ext/napoleon')
| -rw-r--r-- | sphinx/ext/napoleon/__init__.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/sphinx/ext/napoleon/__init__.py b/sphinx/ext/napoleon/__init__.py index ba8f62a18..8e513a9d0 100644 --- a/sphinx/ext/napoleon/__init__.py +++ b/sphinx/ext/napoleon/__init__.py @@ -240,7 +240,7 @@ class Config: :returns: *bool* -- True if successful, False otherwise napoleon_preprocess_types : :obj:`bool` (Defaults to False) - Enable the type preprocessor for numpy style docstrings. + Enable the type preprocessor. napoleon_type_aliases : :obj:`dict` (Defaults to None) Add a mapping of strings to string, translating types in numpy |