Skip to content

Latest commit

 

History

History
26 lines (19 loc) · 1.12 KB

README.rst

File metadata and controls

26 lines (19 loc) · 1.12 KB
https://travis-ci.org/numpy/numpydoc.png?branch=master

numpydoc -- Numpy's Sphinx extensions

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 numpydoc extension provides support for the Numpy docstring format in Sphinx, and adds the code description directives np:function, np-c:function, etc. that support the Numpy docstring syntax.

See numpydoc docstring guide for how to write docs that use this extension, and the user guide

Numpydoc inserts a hook into Sphinx's autodoc that converts docstrings following the Numpy/Scipy format to a form palatable to Sphinx.