Redo Documentation

[teknogeek]

Documentation needs to be redone according to the style guides laid out here

[nmpiazza]

We should consider setting up Sphinx for documentation. It's pretty standard and will parse the google comment style listed above.

For setup and other documentation we should probably prioritize the GitHub wiki.

[teknogeek]

Can Sphinx read the google documentation formatting originally linked?

[nmpiazza]

Yes, it supports that. I've used this on other projects recently.

[nmpiazza]

Example documentation that's a little easier to read than their outline can be found here
https://github.com/nmpiazza/Hermes/blob/76c9c0e3efb9eef928b749a20a3806e1131ba738/app/mod_check/HTTP.py#L8-L24

[teknogeek]

Thanks for that example, I like the look of that a lot