We should have automatically generated Sphinx documentation for our code. For now, we will follow the basic Sphinx (reStructuredText) layout for docstrings. Handily, pycharm can help us out with this formatting for free. This PR requires three things:
1, A first stab of Sphinx documentation for the project
A method to regenerate the documentation on demand
A document in the wiki to lay out exactly how we should document our code.
We should have automatically generated Sphinx documentation for our code. For now, we will follow the basic Sphinx (reStructuredText) layout for docstrings. Handily, pycharm can help us out with this formatting for free. This PR requires three things:
1, A first stab of Sphinx documentation for the project