DocumentationΒΆ

The documentation here is generated by way of sphinx and a few other dependencies. You can generally cd into the docs folder, install requirements, and then build:

After build, the documentation will be in the _build/html folder. You can cd to that location and deploy a local webserver to view it:

For the above, you would open to port 9999 to see the rendered docs.