sphinx numpy style

This example shows how to use the Numpy style docstrings with Sphinx

Example NumPy style docstrings.

This module demonstrates documentation as specified by the NumPy Documentation HOWTO. Docstrings may extend over multiple lines. Sections are created with a section header followed by an underline of equal length.

Example

Examples can be given using either the Example or Examples sections. Sections support any reStructuredText formatting, including literal blocks:

$ python example_numpy.py

Section breaks are created with two blank lines. Section breaks are also implicitly created anytime a new section starts. Section bodies may be indented:

Notes

This is an example of an indented section. It’s like any other section, but the body is indented to help it stand out from surrounding text.

If a section is indented, then a section break is created by resuming unindented text.

python_plugins.examples.sphinx_numpy_style.module_level_variable1

Module level variables may be documented in either the Attributes section of the module docstring, or in an inline docstring immediately following the variable.

Either form is acceptable, but the two should not be mixed. Choose one convention to document module level variables and be consistent with it.

Type:: int

class python_plugins.examples.sphinx_numpy_style.ExampleClass(param1, param2, param3)

The summary line for a class docstring should fit on one line.

If the class has public attributes, they may be documented here in an Attributes section and follow the same formatting as a function’s Args section. Alternatively, attributes may be documented inline with the attribute’s declaration (see __init__ method below).

Properties created with the @property decorator should be documented in the property’s getter method.

attr1

Description of attr1.

Type:: str

attr2

Description of attr2.

Type:: int, optional

attr3: Doc comment inline with attribute

attr4

Doc comment before attribute, with type specified

Type:: list(str)

attr5

Docstring after attribute, with type specified.

Type:: str

example_method(param1, param2)

Class methods are similar to regular functions.

Note

Do not include the self parameter in the Parameters section.

Parameters:

param1 – The first parameter.
param2 – The second parameter.

Returns:

True if successful, False otherwise.

Return type:

bool

property readonly_property

Properties should be documented in their getter method.

Type:: str

property readwrite_property

Properties with both a getter and setter should only be documented in their getter method.

If the setter method contains notable behavior, it should be mentioned here.

Type:: list(str)

exception python_plugins.examples.sphinx_numpy_style.ExampleError(msg, code)

Exceptions are documented in the same way as classes.

The __init__ method may be documented in either the class level docstring, or as a docstring on the __init__ method itself.

Either form is acceptable, but the two should not be mixed. Choose one convention to document the __init__ method and be consistent with it.

Note

Do not include the self parameter in the Parameters section.

Parameters:

msg (str) – Human readable string describing the exception.
code (int, optional) – Numeric error code.

msg

Human readable string describing the exception.

Type:: str

code

Numeric error code.

Type:: int

python_plugins.examples.sphinx_numpy_style.example_generator(n)

Generators have a Yields section instead of a Returns section.

Parameters:: n (int) – The upper limit of the range to generate, from 0 to n - 1.
Yields:: int – The next number in the range of 0 to n - 1.

Examples

Examples should be written in doctest format, and should illustrate how to use the function.

>>> print([i for i in example_generator(4)])
[0, 1, 2, 3]

python_plugins.examples.sphinx_numpy_style.function_with_pep484_type_annotations(param1: int, param2: str) → bool

Example function with PEP 484 type annotations.

The return type must be duplicated in the docstring to comply with the NumPy docstring style.

Parameters:

param1 – The first parameter.
param2 – The second parameter.

Returns:

True if successful, False otherwise.

Return type:

bool

python_plugins.examples.sphinx_numpy_style.function_with_types_in_docstring(param1, param2)

Example function with types documented in the docstring.

PEP 484 type annotations are supported. If attribute, parameter, and return types are annotated according to PEP 484, they do not need to be included in the docstring:

Parameters:

param1 (int) – The first parameter.
param2 (str) – The second parameter.

Returns:

True if successful, False otherwise.

Return type:

bool

python_plugins.examples.sphinx_numpy_style.module_level_function(param1, param2=None, *args, **kwargs)

This is an example of a module level function.

Function parameters should be documented in the Parameters section. The name of each parameter is required. The type and description of each parameter is optional, but should be included if not obvious.

If *args or **kwargs are accepted, they should be listed as *args and **kwargs.

The format for a parameter is:

name : type
    description

    The description may span multiple lines. Following lines
    should be indented to match the first line of the description.
    The ": type" is optional.

    Multiple paragraphs are supported in parameter
    descriptions.

Parameters:

param1 (int) – The first parameter.
param2 (str, optional) – The second parameter.
*args – Variable length argument list.
**kwargs – Arbitrary keyword arguments.

Returns:

True if successful, False otherwise.

The return type is not optional. The Returns section may span multiple lines and paragraphs. Following lines should be indented to match the first line of the description.

The Returns section supports any reStructuredText formatting, including literal blocks:

{
    'param1': param1,
    'param2': param2,
}

Return type:

bool

Raises:

AttributeError – The Raises section is a list of all exceptions that are relevant to the interface.
ValueError – If param2 is equal to param1.

python_plugins.examples.sphinx_numpy_style.module_level_variable2 = 98765

Module level variable documented inline.

The docstring may span multiple lines. The type may optionally be specified on the first line, separated by a colon.

Type:: int