Numpy's Sphinx extensions
Switch branches/tags
Nothing to show
Clone or download

README.rst

https://travis-ci.org/numpy/numpydoc.png?branch=master

numpydoc -- Numpy's Sphinx extensions

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.

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.