diff --git a/README.rst b/README.rst index 71748401..3d680a55 100644 --- a/README.rst +++ b/README.rst @@ -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 +`__. +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 +`_. -See `numpydoc docstring guide `_ -for how to write docs that use this extension, and the `user guide `_ - -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 +`_ explains how +to write docs formatted for this extension, and the `user guide +`_ explains how to use it with Sphinx.