add documentation branch

[SuperKogito]

Sphinx generated docs

[vsoch]

Will this be done on an automated build, for a release? Just manually updated for now?

[codecov]

Codecov Report

Merging #33 into master will not change coverage by %.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #33   +/-   ##
=======================================
  Coverage   86.37%   86.37%           
=======================================
  Files           7        7           
  Lines         301      301           
=======================================
  Hits          260      260           
  Misses         41       41           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 78265c7...78a71f0. Read the comment docs.

[SuperKogito]

Well my idea is to host these on readthedocs.com and they will be automatically generated/updated when the code is changed. I don't think these docs are very useful for users atm unless we add more use cases and examples to them. However, for now the docs will serve as a guide for us (developers) and any contributors/ users who need to know more about the code. what do you think about it?

[vsoch]

I've had best luck with hosting docs alongside code, that way they are versioned with it, and I've also had general / weird build issues with readthedocs that are hard to debug. If you feel strongly about it, it's definitely commonly done, but I would advocate for keeping the documentation under docs/ alongside the code (so it's versioned and released with it) and then having an automated build process to update them on some event (release, etc.)