diff options
| author | Ben Nathanson <github@bigriver.xyz> | 2020-05-29 09:59:36 -0400 |
|---|---|---|
| committer | Ben Nathanson <github@bigriver.xyz> | 2020-05-29 09:59:36 -0400 |
| commit | b859172f64f71f3936d070028423be3ba987b86e (patch) | |
| tree | be893387f2aca6aefe26d715fd031c74d4e9701e | |
| parent | 5a4140d722117afc89869d5772ddd7a67448cfbc (diff) | |
| download | numpy-b859172f64f71f3936d070028423be3ba987b86e.tar.gz | |
DOC: Add style guide to howto_document
Fixes gh-16262
| -rw-r--r-- | doc/source/docs/howto_document.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/source/docs/howto_document.rst b/doc/source/docs/howto_document.rst index 2a97a100d..cf86b7e99 100644 --- a/doc/source/docs/howto_document.rst +++ b/doc/source/docs/howto_document.rst @@ -4,6 +4,13 @@ A Guide to NumPy/SciPy Documentation ==================================== +User documentation +******************* +NumPy text documents should follow the `Google developer documentation style guide <https://developers.google.com/style>`_. + +Docstrings +********** + When using `Sphinx <http://www.sphinx-doc.org/>`__ in combination with the numpy conventions, you should use the ``numpydoc`` extension so that your docstrings will be handled correctly. For example, Sphinx will extract the |