python-numpydoc

Custom extension for python-Sphinx from the python-numpy project

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: - numpydoc: support for the Numpy docstring format in Sphinx, and add the code description directives np:function, np-c:function, etc. that support the Numpy docstring syntax. - numpydoc.traitsdoc: For gathering documentation about Traits attributes. - numpydoc.plot_directives: Adaptation of Matplotlib's plot:: directive. This implementation may still undergo severe changes or eventually be deprecated. - numpydoc.only_directives: (DEPRECATED) - numpydoc.autosummary: (DEPRECATED) An autosummary:: directive. Available in Sphinx 0.6.2 and (to-be) 1.0 as sphinx.ext.autosummary, and it the Sphinx 1.0 version is recommended over that included in Numpydoc.