summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorJoel Nothman <joel.nothman@gmail.com>2017-10-23 07:35:15 +1100
committerJoel Nothman <joel.nothman@gmail.com>2017-10-23 07:35:15 +1100
commit3213701c2431cdb2a88fea28ad3fc1a106f0d588 (patch)
tree46fb29d30a9eb97089a1bb767dcfd9080e474366 /README.rst
parent88ff39f221c0759e258fc0519694e232c8a890df (diff)
parente5c367593acc37853754660d4f42d9dbc1cc6174 (diff)
downloadnumpydoc-3213701c2431cdb2a88fea28ad3fc1a106f0d588.tar.gz
Merge branch 'doc' of github.com:jnothman/numpydoc into doc
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst14
1 files changed, 3 insertions, 11 deletions
diff --git a/README.rst b/README.rst
index c940336..7174840 100644
--- a/README.rst
+++ b/README.rst
@@ -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>`_