diff options
author | Joel Nothman <joel.nothman@gmail.com> | 2017-10-22 23:41:20 +1100 |
---|---|---|
committer | Joel Nothman <joel.nothman@gmail.com> | 2017-10-22 23:41:20 +1100 |
commit | 1ba288f1fefa0f9e311fde32b0d6fe3cab5fb748 (patch) | |
tree | 1f0ba2330445667dd40aff4114ecb8034f7e15da /README.rst | |
parent | 449d789cbef07600a1cebe1965d08b5c1035758d (diff) | |
download | numpydoc-1ba288f1fefa0f9e311fde32b0d6fe3cab5fb748.tar.gz |
Update readme pursuant to ad672f1 (#71)
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 14 |
1 files changed, 3 insertions, 11 deletions
@@ -9,17 +9,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 `A Guide to NumPy/SciPy Documentation <https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`_ for how to write docs that use this extension. |