Improve Documentation

[rykener]

Documentation is currently subpar, and would benefit from attention. Goals are to write full docs with Sphinx to then host on Read the Docs. Anyone who wants to help is welcome to do so.

[ChristopherLandaverde]

Hey @shonin I would love to help on this

[rykener]

hey @ChristopherLandaverde, great, any idea what you can contribute? Things that need to get done are

• Sphinx setup
• convert the current readme into the bare-bones new documentation, which should be written in .rst
• update the documentation to be more robust
• proofreading

if you had something else in mind that I didn't list feel free to let me know

[ChristopherLandaverde]

Hey @shonin

So I will be working on converting the read me, sphinx set up, and proofreading.

Do you mind if I continue to use? .md and would you be interested in adding docstrings?