This package provides the numpydoc
Sphinx extension for handling
docstrings formatted according to the NumPy documentation format.
The extension also adds the code description directives
np:function
, np-c:function
, etc.
numpydoc requires Python 3.8+ and sphinx 5+.
For usage information, please refer to the documentation.
The numpydoc docstring guide explains how to write docs formatted for this extension, and the user guide explains how to use it with Sphinx.