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

rename the configuration option

Browse Source
This commit is contained in:
Keewis 2020-05-29 19:16:17 +02:00
parent ad89b1f76a
commit e1d7edac25
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -41,7 +41,7 @@ class Config:
napoleon_use_param = True
napoleon_use_rtype = True
napoleon_use_keyword = True
napoleon_numpy_type_aliases = None
napoleon_type_aliases = None
napoleon_custom_sections = None
.. _Google style:
@ -237,8 +237,8 @@ class Config:
:returns: *bool* -- True if successful, False otherwise
napoleon_numpy_type_aliases : :obj:`dict` (Defaults to None)
Add a mapping of strings to string, translating types.
napoleon_type_aliases : :obj:`dict` (Defaults to None)
Add a mapping of strings to string, translating types in numpy style docstrings.
napoleon_custom_sections : :obj:`list` (Defaults to None)
Add a list of custom sections to include, expanding the list of parsed sections.
@ -267,7 +267,7 @@ class Config:
'napoleon_use_param': (True, 'env'),
'napoleon_use_rtype': (True, 'env'),
'napoleon_use_keyword': (True, 'env'),
'napoleon_numpy_type_aliases': (None, 'env'),
'napoleon_type_aliases': (None, 'env'),
'napoleon_custom_sections': (None, 'env')
}

2
sphinx/ext/napoleon/docstring.py
View File

@ -997,7 +997,7 @@ class NumpyDocstring(GoogleDocstring):
_name = self._escape_args_and_kwargs(_name)
_type = _convert_numpy_type_spec(
_type,
translations=self._config.napoleon_numpy_type_aliases or {},
translations=self._config.napoleon_type_aliases or {},
)
if prefer_type and not _type: