diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 14 |
1 files changed, 3 insertions, 11 deletions
@@ -15,17 +15,9 @@ 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_directive``: Adaptation of Matplotlib's ``plot::`` - directive. Note that this implementation may still undergo severe - changes or eventually be deprecated. +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 <https://numpydoc.readthedocs.io/en/latest/format.html>`_ for how to write docs that use this extension, and the `user guide <https://numpydoc.readthedocs.io>`_ |