aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAaron LI <aaronly.me@outlook.com>2016-09-29 15:40:04 +0800
committerAaron LI <aaronly.me@outlook.com>2016-09-29 15:40:04 +0800
commitc3cba1871c5acfabbab362a695d5c763d7a55d32 (patch)
treedea45aec5fca07be3bd8339a1f1208e950d53e7f
parent0aeeaf289ec31da902a9a5e614c1686baf880a29 (diff)
downloadfg21sim-c3cba1871c5acfabbab362a695d5c763d7a55d32.tar.bz2
CONTRIBUTING.md: Add Python documentation guidelines
-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