Developer’s Guide 102: Documenting

Document

We are using Read The Docs theme for Sphinx.

Run tox command:

tox -e docs

to build html and man pages for documentation

Also by executing:

tox -e serve-docs

the page under /docs/build/html is hosted by localhost.

Use also command:

tox -e doc8

to ensure that documentation standards are being followed.