How to document this package

Background

This package uses sphinx and the Read the Docs theme to document its functions and usage. The sphinx package makes it easy to automatically build pretty documentation.

For first time installation (no longer necessary)

  1. conda install sphinx in git bash

  2. sphinx-quickstart in git bash

  3. pip install sphinx-rtd-theme in git bash

  4. conda install pandoc in git bash

  5. make html

For developers

  1. make html in cmd (if on Windows)