DocumentationΒΆ

Package documentation is generated by Sphinx and uploaded to readthedocs.io. To build the documentation manually just call:

$ make docs

After a successful build the documentation index is opened in your web browser. You can override the command to open the browser (default xdg-open) with the BROWSER make variable, e.g.:

$ make BROWSER=chromium-browser docs