summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKeewis <keewis@posteo.de>2020-08-10 13:03:50 +0200
committerKeewis <keewis@posteo.de>2020-08-10 13:03:50 +0200
commit2d180e49c268fa5f9574a1f594e7e253e4c196b7 (patch)
tree3174f6167f8657513276548c217d0ef1c2ab30b7
parentbf26080042fabf6e3aba22cfe05ad8d93bcad3e9 (diff)
downloadsphinx-git-2d180e49c268fa5f9574a1f594e7e253e4c196b7.tar.gz
add a setting to disable the type preprocessor
-rw-r--r--sphinx/ext/napoleon/__init__.py7
1 files changed, 6 insertions, 1 deletions
diff --git a/sphinx/ext/napoleon/__init__.py b/sphinx/ext/napoleon/__init__.py
index 6cab63c9f..793384dd2 100644
--- a/sphinx/ext/napoleon/__init__.py
+++ b/sphinx/ext/napoleon/__init__.py
@@ -41,6 +41,7 @@ class Config:
napoleon_use_param = True
napoleon_use_rtype = True
napoleon_use_keyword = True
+ napoleon_preprocess_types = True
napoleon_type_aliases = None
napoleon_custom_sections = None
@@ -237,9 +238,12 @@ class Config:
:returns: *bool* -- True if successful, False otherwise
+ napoleon_preprocess_types : :obj:`bool` (Defaults to True)
+ Enable the type preprocessor for numpy style docstrings.
+
napoleon_type_aliases : :obj:`dict` (Defaults to None)
Add a mapping of strings to string, translating types in numpy
- style docstrings.
+ style docstrings. Only works if ``napoleon_preprocess_types = True``.
napoleon_custom_sections : :obj:`list` (Defaults to None)
Add a list of custom sections to include, expanding the list of parsed sections.
@@ -268,6 +272,7 @@ class Config:
'napoleon_use_param': (True, 'env'),
'napoleon_use_rtype': (True, 'env'),
'napoleon_use_keyword': (True, 'env'),
+ 'napoleon_preprocess_types': (True, 'env'),
'napoleon_type_aliases': (None, 'env'),
'napoleon_custom_sections': (None, 'env')
}