Skip to content

Commit

Permalink
Merge pull request #158 from stefanv/simplify_readme
Browse files Browse the repository at this point in the history
Simplify and restructure README
  • Loading branch information
rgommers committed Mar 9, 2018
2 parents 09a945f + 0f4922e commit 21a194e
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@
numpydoc -- Numpy's Sphinx extensions
=====================================

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.
This package provides the ``numpydoc`` Sphinx extension for handling
docstrings formatted according to the `NumPy documentation format
<https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`__.
The extension also adds the code description directives
``np:function``, ``np-c:function``, etc.

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.
For usage information, please refer to the `documentation
<https://numpydoc.readthedocs.io/>`_.

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>`_

Numpydoc inserts a hook into Sphinx's autodoc that converts docstrings
following the Numpy/Scipy format to a form palatable to Sphinx.
The `numpydoc docstring guide
<https://numpydoc.readthedocs.io/en/latest/format.html>`_ explains how
to write docs formatted for this extension, and the `user guide
<https://numpydoc.readthedocs.io>`_ explains how to use it with Sphinx.

0 comments on commit 21a194e

Please sign in to comment.