Documentation¶
Building Documentation¶
Activate the development virtual environment
Run
$ docs/make clean
to remove any docs previously builtRun
$ docs/make html
to build the docs in HTML formatChange the current directory to the location of the built docs by running
$ cd docs/_build/html
Start the Python static files server by running
$ python -m http.server
Visit
localhost:8000
in your browser to view the docs
Generating the Documentation¶
Activate the development virtual environment
Generate the docs by running
$ sphinx-apidoc -f -o docs/_sources . main.py manage.py *migrations* *tests*