diff --git a/doc/HOWTO_DOCUMENT.rst.txt b/doc/HOWTO_DOCUMENT.rst.txt index 61d7c39415d2..eeeb50711ab6 100644 --- a/doc/HOWTO_DOCUMENT.rst.txt +++ b/doc/HOWTO_DOCUMENT.rst.txt @@ -9,6 +9,26 @@ A Guide to NumPy/SciPy Documentation For an accompanying example, see `example.py `_. + When using `Sphinx `_ in combination with the numpy + conventions, you may be interested in the ``numpydoc`` extension, which will + handle your docstrings correctly. For example, it will extract the + ``Parameters`` section from your docstring and convert this into a field list. + It can also help alleviate reStructuredText errors encounterde when using + plain sphinx. Sphinx gets confused because the numpy docstrings have section + headers (e.g. ``-------------``) which sphinx does not expect to find in + docstrings. + + It is available from: + + * `numpydoc on PyPI `_ + * `numpydoc on GitHub (in main numpy repository) + `_ + + Details of how to use it can be found `here + `_ and + `here + `_ + Overview -------- In general, we follow the standard Python style conventions as described here: diff --git a/doc/sphinxext/numpydoc.py b/doc/sphinxext/numpydoc.py index 43c67336b5c0..7679352c2e23 100644 --- a/doc/sphinxext/numpydoc.py +++ b/doc/sphinxext/numpydoc.py @@ -12,7 +12,7 @@ - Renumber references. - Extract the signature from the docstring, if it can't be determined otherwise. -.. [1] http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines#docstring-standard +.. [1] https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt """