diff options
| author | Aaron LI <aaronly.me@outlook.com> | 2016-09-29 18:56:36 +0800 |
|---|---|---|
| committer | Aaron LI <aaronly.me@outlook.com> | 2016-09-29 18:56:36 +0800 |
| commit | 20081ab8a88a42e57644d729345ec75aee3da132 (patch) | |
| tree | 351df2ca9310079b9541cbac90406f6b79098a3e /CONTRIBUTING.md | |
| parent | 8d9339d501162583232ddc16ddab48bd55349069 (diff) | |
| parent | c3cba1871c5acfabbab362a695d5c763d7a55d32 (diff) | |
| download | fg21sim-20081ab8a88a42e57644d729345ec75aee3da132.tar.bz2 | |
Merge branch 'master' into logging
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 11 |
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 |