Autodoc Formatting

[brandtdamman]

Current Documentation

All API documentation within the Python program is done in a generalized format.

Desired Documentation

API documentation should be formatted appropriately such that a program like Sphinx or Doxygen can be used to produce HTML friendly pages.

Reasoning

This will reduce the time spent digging around for API documentation within code and make it more readily accessible.

[Nick-Vazquez]

Going with Sphinx

[Nick-Vazquez]

Thomas and I met today to work on this a bit, as it's a dependency to #21.

Some things we came up with/discovered

1. We decided to use Sphinx, as this has slightly better documentation on install and use.
2. We're currently using reST markup, but this can be changed to NumPy/Google docs if desired
3. Paths and parsing of modules can be tricky, especially because error messages are not concise (and we're learning more)

Moving Forward

1. Find a way to hierarchical structure to the documents, cleaning up the main index.rst page
2. Learn more about reST markup and its' components.

We've started a document for taking notes on the sphinx branch. (Yes, we could have put this in docs/changes/sphinx, but Git did not seem to like this). Once we've implemented this at least to a useable state, we will include full setup instructions and docs.

[brandtdamman]

reST markup sounds excellent. Regarding comments related to Wiki/Pages, which ever works best first time around is more crucial. Proof-of-concept is the primary goal, so if it makes it easier to work with GitHub Pages, aim to make that work first.

[tvgaul]

Changed the current comments to fit the restructuredText format