Skip to content

Commit 1ba288f

Browse files
committed
Update readme pursuant to ad672f1 (numpy#71)
1 parent 449d789 commit 1ba288f

File tree

1 file changed

+3
-11
lines changed

1 file changed

+3
-11
lines changed

README.rst

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,9 @@ Numpy's documentation uses several custom extensions to Sphinx. These
99
are shipped in this ``numpydoc`` package, in case you want to make use
1010
of them in third-party projects.
1111

12-
The following extensions are available:
13-
14-
- ``numpydoc``: support for the Numpy docstring format in Sphinx, and add
15-
the code description directives ``np:function``, ``np-c:function``, etc.
16-
that support the Numpy docstring syntax.
17-
18-
- ``numpydoc.traitsdoc``: For gathering documentation about Traits attributes.
19-
20-
- ``numpydoc.plot_directive``: Adaptation of Matplotlib's ``plot::``
21-
directive. Note that this implementation may still undergo severe
22-
changes or eventually be deprecated.
12+
The ``numpydoc`` extension provides support for the Numpy docstring format in
13+
Sphinx, and adds the code description directives ``np:function``,
14+
``np-c:function``, etc. that support the Numpy docstring syntax.
2315

2416
See `A Guide to NumPy/SciPy Documentation <https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`_
2517
for how to write docs that use this extension.

0 commit comments

Comments
 (0)