Skip to content

Commit 8a8f9e7

Browse files
authored
Merge pull request #150 from tetov/patch-1
Add paragraph about docstring style
2 parents 73eea94 + 2703f30 commit 8a8f9e7

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

CONTRIBUTING.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,10 @@ introduction/examples/usage documentation or API documentation in docstrings.
6060
Documentation is written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_
6161
and use `Sphinx <http://sphinx-doc.org/index.html>`_ to generate the HTML output.
6262

63+
The project uses Numpy style docstrings, see
64+
`Sphinx extension Napoleon's documentation <https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html>`_
65+
for examples.
66+
6367
Once you made the documentation changes locally, run the documentation generation::
6468

6569
invoke docs

0 commit comments

Comments
 (0)