We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent ac7ec86 commit b786417Copy full SHA for b786417
1 file changed
{{cookiecutter.project_slug}}/README.rst
@@ -64,9 +64,10 @@ Documentation
64
-------------
65
66
* 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)
+* We recommend writing the documentation using Restructured Text (reST) and Google style docstrings.
68
69
- `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>`_.
71
72
* To generate html documentation run ``python setup.py build_sphinx``
73
0 commit comments