|
11 | 11 | numpydoc -- Numpy's Sphinx extensions
|
12 | 12 | =====================================
|
13 | 13 |
|
14 |
| -Numpy's documentation uses several custom extensions to Sphinx. These |
15 |
| -are shipped in this ``numpydoc`` package, in case you want to make use |
16 |
| -of them in third-party projects. |
| 14 | +This package provides the ``numpydoc`` Sphinx extension for handling |
| 15 | +docstrings formatted according to the `NumPy documentation format |
| 16 | +<https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`__. |
| 17 | +The extension also adds the code description directives |
| 18 | +``np:function``, ``np-c:function``, etc. |
17 | 19 |
|
18 |
| -The ``numpydoc`` extension provides support for the Numpy docstring format in |
19 |
| -Sphinx, and adds the code description directives ``np:function``, |
20 |
| -``np-c:function``, etc. that support the Numpy docstring syntax. |
| 20 | +For usage information, please refer to the `documentation |
| 21 | +<https://numpydoc.readthedocs.io/>`_. |
21 | 22 |
|
22 |
| -See `numpydoc docstring guide <https://numpydoc.readthedocs.io/en/latest/format.html>`_ |
23 |
| -for how to write docs that use this extension, and the `user guide <https://numpydoc.readthedocs.io>`_ |
24 |
| - |
25 |
| -Numpydoc inserts a hook into Sphinx's autodoc that converts docstrings |
26 |
| -following the Numpy/Scipy format to a form palatable to Sphinx. |
| 23 | +The `numpydoc docstring guide |
| 24 | +<https://numpydoc.readthedocs.io/en/latest/format.html>`_ explains how |
| 25 | +to write docs formatted for this extension, and the `user guide |
| 26 | +<https://numpydoc.readthedocs.io>`_ explains how to use it with Sphinx. |
0 commit comments