Support for NumPy and Google style docstrings.
Unknown Field: copyright | |
Copyright 2007-2022 by the Sphinx team, see AUTHORS. | |
Unknown Field: license | |
BSD, see LICENSE for details. |
Module | docstring |
sphinx.ext.napoleon.docstring ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
Module | iterators |
sphinx.ext.napoleon.iterators ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
From __init__.py
:
Class | Config |
Sphinx napoleon extension settings in conf.py . |
Function | _patch_python_domain |
Undocumented |
Function | _process_docstring |
Process the docstring for a given python object. |
Function | _skip_member |
Determine if private and special class members are included in docs. |
Function | setup |
Sphinx extension setup function. |
Sphinx extension setup function.
When the extension is loaded, Sphinx imports this module and executes the setup() function, which in turn notifies Sphinx of everything the extension offers.
Parameters | |
app:Sphinx | Undocumented |
Returns | |
Dict[ | Undocumented |
Process the docstring for a given python object.
Called when autodoc has read and processed a docstring. lines
is a list
of docstring lines that _process_docstring
modifies in place to change
what Sphinx outputs.
The following settings in conf.py control what styles of docstrings will be parsed:
The lines of the docstring, see above.
Note
lines
is modified in place
Parameters | |
app:Sphinx | Undocumented |
what:str | Undocumented |
name:str | Undocumented |
obj:Any | Undocumented |
options:Any | Undocumented |
lines:List[ | Undocumented |
Determine if private and special class members are included in docs.
The following settings in conf.py determine if private and special class members or init methods are included in the generated documentation:
obj
will be A.__init__
._skip_member
does not override the decisionParameters | |
app:Sphinx | Undocumented |
what:str | Undocumented |
name:str | Undocumented |
obj:Any | Undocumented |
skip:bool | Undocumented |
options:Any | Undocumented |
Returns | |
bool | Undocumented |