sphinx.ext.napoleon.docstring.NumpyDocstring

Parameters

docstring : str or list of str

The docstring to parse, given either as a string or split into individual lines.

config: sphinx.ext.napoleon.Config or sphinx.config.Config

The configuration settings to use. If not given, defaults to the config object on app; or if app is not given defaults to the a new sphinx.ext.napoleon.Config object.

Other Parameters

app : sphinx.application.Sphinx, optional

Application object representing the Sphinx process.

what : str, optional

A string specifying the type of the object to which the docstring belongs. Valid values: "module", "class", "exception", "function", "method", "attribute".

name : str, optional

The fully qualified name of the object.

obj : module, class, exception, function, method, or attribute

The object to which the docstring belongs.

options : sphinx.ext.autodoc.Options, optional

The options given to the directive: an object with attributes inherited_members, undoc_members, show_inheritance and noindex that are True if the flag option of same name was given to the auto directive.

Example

>>> from sphinx.ext.napoleon import Config
>>> config = Config(napoleon_use_param=True, napoleon_use_rtype=True)
>>> docstring = '''One line summary.
...
... Extended description.
...
... Parameters
... ----------
... arg1 : int
...     Description of `arg1`
... arg2 : str
...     Description of `arg2`
... Returns
... -------
... str
...     Description of return value.
... '''
>>> print(NumpyDocstring(docstring, config))
One line summary.
<BLANKLINE>
Extended description.
<BLANKLINE>
:param arg1: Description of `arg1`
:type arg1: int
:param arg2: Description of `arg2`
:type arg2: str
<BLANKLINE>
:returns: Description of return value.
:rtype: str
<BLANKLINE>

Methods

__str__()

Return the parsed docstring in reStructuredText format.

str

UTF-8 encoded version of the docstring.

__unicode__()

Return the parsed docstring in reStructuredText format.

unicode

Unicode version of the docstring.

lines()

Return the parsed lines of the docstring in reStructuredText format.

list(str)

The lines of the docstring in a list.