aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 370d178..b2252c3 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -123,6 +123,17 @@ So make sure it is installed before carrying on.
and you're ready to go.
+Documentation Guidelines
+------------------------------
+
+### Python
+
+Please adhere to the [NumPy/SciPy Documentation Guide](https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt),
+thus the [``Sphinx``](http://www.sphinx-doc.org/) tool can be used to create the documentation at ease.
+
+There is also an [Example NumPy Style Python Docstrings](http://www.sphinx-doc.org/en/stable/ext/example_numpy.html) for a quick reference.
+
+
License
-------
By contributing your code, you agree to license your contribution under