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

Update #2374: [Napoleon] clarifies documentation of napoleon_include_init_with_doc conf value

Browse Source
This commit is contained in:
Rob Ruana 2016-06-11 16:12:26 -06:00
parent e41a6340da
commit eb95eaf142
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -58,9 +58,10 @@ class Config(object):
True to parse `NumPy style`_ docstrings. False to disable support True to parse `NumPy style`_ docstrings. False to disable support
for NumPy style docstrings. for NumPy style docstrings.
napoleon_include_init_with_doc : bool, defaults to False napoleon_include_init_with_doc : bool, defaults to False
True to include init methods (i.e. ``__init___``) with True to list ``__init___`` docstrings separately from the class
docstrings in the documentation. False to fall back to Sphinx's docstring. False to fall back to Sphinx's default behavior, which
default behavior. considers the ``__init___`` docstring as part of the class
documentation.
**If True**:: **If True**::
@ -206,10 +207,11 @@ class Config(object):
False to use a single ``:keyword arguments:`` role for all the False to use a single ``:keyword arguments:`` role for all the
keywords. keywords.
This behaves similarly to :attr:`napoleon_use_param`. Note unlike docutils, This behaves similarly to :attr:`napoleon_use_param`. Note unlike
``:keyword:`` and ``:param:`` will not be treated the same way - there will docutils, ``:keyword:`` and ``:param:`` will not be treated the same
be a separate "Keyword Arguments" section, rendered in the same fashion as way - there will be a separate "Keyword Arguments" section, rendered
"Parameters" section (type links created if possible) in the same fashion as "Parameters" section (type links created if
possible)
See Also See Also
-------- --------