Sphinx extension to support docstrings in Numpy format
Numpy’s documentation uses several custom extensions to Sphinx. These are shipped in this numpydoc package, in case you want to make use of them in third-party projects.
The following extensions are available:
See A Guide to NumPy/SciPy Documentation for how to write docs that use this extension.
Numpydoc inserts a hook into Sphinx’s autodoc that converts docstrings following the Numpy/Scipy format to a form palatable to Sphinx.
The following options can be set in conf.py:
Whether to produce plot:: directives for Examples sections that contain import matplotlib.
Whether to show all members of a class in the Methods and Attributes sections automatically. True by default.
Whether to show all inherited members of a class in the Methods and Attributes sections automatically. If it’s false, inherited members won’t shown. True by default.
Whether to create a Sphinx table of contents for the lists of class methods and attributes. If a table of contents is made, Sphinx expects each entry to have a separate page. True by default.
numpydoc_edit_link: bool (DEPRECATED – edit your HTML template instead)
Whether to insert an edit link after docstrings.