Documentation Guidelines

All code contributed to this should be documented: every module, class, method, or function should contain a doc string whose size depends on the size and importance of the function. Very small function can have a 1 liner doc string, whereas larger functions need should contain extensive doc strings following the numpy standard (see https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt, Build with numpydoc Sphinx extension?) that is doc strings with restructured text for the formatting. It should include a one-liner description followed by an extensive description, as well as a section on the list of inputs, and one on the outputs below. API level functions or classes should also include a section with examples in addition.

User manual and other documentation is included in the doc/ folder in the project and also hosted compiled on gh-pages? on readthedocs?