Skip to content

Commit b786417

Browse files
author
Janneke van der Zwaan
committed
Add recommendation to use Google style docstrings
1 parent ac7ec86 commit b786417

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

{{cookiecutter.project_slug}}/README.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,10 @@ Documentation
6464
-------------
6565

6666
* Documentation should be put in the ``docs`` folder. The contents have been generated using ``sphinx-quickstart`` (Sphinx version 1.6.5).
67-
* We recommend writing the documentation using Restructured Text (reST)
67+
* We recommend writing the documentation using Restructured Text (reST) and Google style docstrings.
6868

6969
- `Restructured Text (reST) and Sphinx CheatSheet <http://openalea.gforge.inria.fr/doc/openalea/doc/_build/html/source/sphinx/rest_syntax.html>`_
70+
- `Google style docstring examples <http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html>`_.
7071

7172
* To generate html documentation run ``python setup.py build_sphinx``
7273

0 commit comments

Comments
 (0)