diff --git a/sphinx/ext/napoleon/__init__.py b/sphinx/ext/napoleon/__init__.py index e3b03fd75..128fbaab5 100644 --- a/sphinx/ext/napoleon/__init__.py +++ b/sphinx/ext/napoleon/__init__.py @@ -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') } diff --git a/sphinx/ext/napoleon/docstring.py b/sphinx/ext/napoleon/docstring.py index 63e2df6bc..5d65887df 100644 --- a/sphinx/ext/napoleon/docstring.py +++ b/sphinx/ext/napoleon/docstring.py @@ -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: