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

document that we don't require use_param = True anymore

Browse Source
This commit is contained in:
Keewis 2020-08-04 11:39:48 +02:00
parent cac6d1787d
commit cb61f0f734
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -239,7 +239,7 @@ class Config:
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. Only works when ``napoleon_use_param = True``. style docstrings.
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.