diff options
| author | Ralf Gommers <ralf.gommers@gmail.com> | 2020-05-29 17:04:32 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-29 17:04:32 +0200 |
| commit | f9e161df7113350b6a0f83d975dbbb5c2fe93ee7 (patch) | |
| tree | 6eb9ad9d111d2d1f42b22dc4c865b7968257ce1e | |
| parent | 076c599f25255d991f59056bd16f80aa72631ffe (diff) | |
| parent | b859172f64f71f3936d070028423be3ba987b86e (diff) | |
| download | numpy-f9e161df7113350b6a0f83d975dbbb5c2fe93ee7.tar.gz | |
Merge pull request #16428 from bjnath/add-style-guide
DOC: Add style guide to howto_document
| -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 |