IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

add a setting to disable the type preprocessor

Browse Source
This commit is contained in:
Keewis 2020-08-10 13:03:50 +02:00
parent bf26080042
commit 2d180e49c2
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
sphinx/ext/napoleon/__init__.py
View File

@ -41,6 +41,7 @@ class Config:
napoleon_use_param = True napoleon_use_param = True
napoleon_use_rtype = True napoleon_use_rtype = True
napoleon_use_keyword = True napoleon_use_keyword = True
napoleon_preprocess_types = True
napoleon_type_aliases = None napoleon_type_aliases = None
napoleon_custom_sections = None napoleon_custom_sections = None
@ -237,9 +238,12 @@ class Config:
:returns: *bool* -- True if successful, False otherwise :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) napoleon_type_aliases : :obj:`dict` (Defaults to None)
Add a mapping of strings to string, translating types in numpy 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) napoleon_custom_sections : :obj:`list` (Defaults to None)
Add a list of custom sections to include, expanding the list of parsed sections. 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_param': (True, 'env'),
'napoleon_use_rtype': (True, 'env'), 'napoleon_use_rtype': (True, 'env'),
'napoleon_use_keyword': (True, 'env'), 'napoleon_use_keyword': (True, 'env'),
'napoleon_preprocess_types': (True, 'env'),
'napoleon_type_aliases': (None, 'env'), 'napoleon_type_aliases': (None, 'env'),
'napoleon_custom_sections': (None, 'env') 'napoleon_custom_sections': (None, 'env')
} }