Skip to content

Sphinx Documentation #3

Open
Open
@michaeljohnbarr

Description

@michaeljohnbarr

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.

  • Create a gh-pages branch.
  • Update all __docstring__'s within the project to the appropriate format.

Metadata

Metadata

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions