While the readme.md file gives a basic idea of the project layout, I would prefer to use Sphinx to generate the documentation to the Github Pages based on the docstring of each class/method.
To do so, we will need to create a gh-pages branch, then commit the Sphinx-generated HTML to that branch.
[x] Create a gh-pages branch.
[ ] Update all __docstring__'s within the project to the appropriate format.
While the readme.md file gives a basic idea of the project layout, I would prefer to use Sphinx to generate the documentation to the Github Pages based on the docstring of each class/method.
To do so, we will need to create a gh-pages branch, then commit the Sphinx-generated HTML to that branch.
gh-pagesbranch.__docstring__'s within the project to the appropriate format.