sphinxcontrib.napoleon package

Sphinx napoleon extension – support for NumPy and Google style docstrings.

class sphinxcontrib.napoleon.Config(**settings)[source]

Bases: object

Sphinx napoleon extension settings in conf.py.

Listed below are all the settings used by napoleon and their default values. These settings can be changed in the Sphinx conf.py file. Make sure that both “sphinx.ext.autodoc” and “sphinxcontrib.napoleon” are enabled in conf.py:

# conf.py

# Add any Sphinx extension module names here, as strings
extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.napoleon']

# Napoleon settings
napoleon_google_docstring = True
napoleon_numpy_docstring = True
napoleon_include_init_with_doc = False
napoleon_include_private_with_doc = False
napoleon_include_special_with_doc = False
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = False
napoleon_use_admonition_for_references = False
napoleon_use_ivar = False
napoleon_use_param = True
napoleon_use_rtype = True
napoleon_use_keyword = True
napoleon_google_docstring

bool (Defaults to True) – True to parse Google style docstrings. False to disable support for Google style docstrings.

napoleon_numpy_docstring

bool (Defaults to True) – True to parse NumPy style docstrings. False to disable support for NumPy style docstrings.

napoleon_include_init_with_doc

bool (Defaults to False) – True to list __init___ docstrings separately from the class docstring. False to fall back to Sphinx’s default behavior, which considers the __init___ docstring as part of the class documentation.

If True:

def __init__(self):
    """
    This will be included in the docs because it has a docstring
    """

def __init__(self):
    # This will NOT be included in the docs
napoleon_include_private_with_doc

bool (Defaults to False) – True to include private members (like _membername) with docstrings in the documentation. False to fall back to Sphinx’s default behavior.

If True:

def _included(self):
    """
    This will be included in the docs because it has a docstring
    """
    pass

def _skipped(self):
    # This will NOT be included in the docs
    pass
napoleon_include_special_with_doc

bool (Defaults to False) – True to include special members (like __membername__) with docstrings in the documentation. False to fall back to Sphinx’s default behavior.

If True:

def __str__(self):
    """
    This will be included in the docs because it has a docstring
    """
    return unicode(self).encode('utf-8')

def __unicode__(self):
    # This will NOT be included in the docs
    return unicode(self.__class__.__name__)
napoleon_use_admonition_for_examples

bool (Defaults to False) – True to use the .. admonition:: directive for the Example and Examples sections. False to use the .. rubric:: directive instead. One may look better than the other depending on what HTML theme is used.

This NumPy style snippet will be converted as follows:

Example
-------
This is just a quick example

If True:

.. admonition:: Example

   This is just a quick example

If False:

.. rubric:: Example

This is just a quick example
napoleon_use_admonition_for_notes

bool (Defaults to False) – True to use the .. admonition:: directive for Notes sections. False to use the .. rubric:: directive instead.

Note

The singular Note section will always be converted to a .. note:: directive.

napoleon_use_admonition_for_references

bool (Defaults to False) – True to use the .. admonition:: directive for References sections. False to use the .. rubric:: directive instead.

napoleon_use_ivar

bool (Defaults to False) – True to use the :ivar: role for instance variables. False to use the .. attribute:: directive instead.

This NumPy style snippet will be converted as follows:

Attributes
----------
attr1 : int
    Description of `attr1`

If True:

:ivar attr1: Description of `attr1`
:vartype attr1: int

If False:

.. attribute:: attr1

   *int*

   Description of `attr1`
napoleon_use_param

bool (Defaults to True) – True to use a :param: role for each function parameter. False to use a single :parameters: role for all the parameters.

This NumPy style snippet will be converted as follows:

Parameters
----------
arg1 : str
    Description of `arg1`
arg2 : int, optional
    Description of `arg2`, defaults to 0

If True:

:param arg1: Description of `arg1`
:type arg1: str
:param arg2: Description of `arg2`, defaults to 0
:type arg2: int, optional

If False:

:parameters: * **arg1** (*str*) --
               Description of `arg1`
             * **arg2** (*int, optional*) --
               Description of `arg2`, defaults to 0
napoleon_use_keyword

bool (Defaults to True) – True to use a :keyword: role for each function keyword argument. False to use a single :keyword arguments: role for all the keywords.

This behaves similarly to napoleon_use_param. Note unlike docutils, :keyword: and :param: will not be treated the same way - there will be a separate “Keyword Arguments” section, rendered in the same fashion as “Parameters” section (type links created if possible)

napoleon_use_rtype

bool (Defaults to True) – True to use the :rtype: role for the return type. False to output the return type inline with the description.

This NumPy style snippet will be converted as follows:

Returns
-------
bool
    True if successful, False otherwise

If True:

:returns: True if successful, False otherwise
:rtype: bool

If False:

:returns: *bool* -- True if successful, False otherwise
sphinxcontrib.napoleon.setup(app)[source]

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.application.Sphinx) – Application object representing the Sphinx process

sphinxcontrib.napoleon.docstring module

Classes for docstring parsing and formatting.

class sphinxcontrib.napoleon.docstring.GoogleDocstring(docstring, config=None, app=None, what='', name='', obj=None, options=None)[source]

Bases: pockets.string.UnicodeMixin

Convert Google style docstrings to reStructuredText.

Parameters:
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 sphinxcontrib.napoleon import Config
>>> config = Config(napoleon_use_param=True, napoleon_use_rtype=True)
>>> docstring = '''One line summary.
...
... Extended description.
...
... Args:
...   arg1(int): Description of `arg1`
...   arg2(str): Description of `arg2`
... Returns:
...   str: Description of return value.
... '''
>>> print(GoogleDocstring(docstring, config))
One line summary.

Extended description.

:param arg1: Description of `arg1`
:type arg1: int
:param arg2: Description of `arg2`
:type arg2: str

:returns: Description of return value.
:rtype: str
__unicode__()[source]

Return the parsed docstring in reStructuredText format.

Returns:Unicode version of the docstring.
Return type:unicode
lines()[source]

Return the parsed lines of the docstring in reStructuredText format.

Returns:The lines of the docstring in a list.
Return type:list(str)
class sphinxcontrib.napoleon.docstring.NumpyDocstring(docstring, config=None, app=None, what='', name='', obj=None, options=None)[source]

Bases: sphinxcontrib.napoleon.docstring.GoogleDocstring

Convert NumPy style docstrings to reStructuredText.

Parameters:
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 sphinxcontrib.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.

Extended description.

:param arg1: Description of `arg1`
:type arg1: int
:param arg2: Description of `arg2`
:type arg2: str

:returns: Description of return value.
:rtype: str
__str__()

Return the parsed docstring in reStructuredText format.

Returns:UTF-8 encoded version of the docstring.
Return type:str
__unicode__()

Return the parsed docstring in reStructuredText format.

Returns:Unicode version of the docstring.
Return type:unicode
lines()

Return the parsed lines of the docstring in reStructuredText format.

Returns:The lines of the docstring in a list.
Return type:list(str)