Documentation

Building Documentation

1. Activate the development virtual environment

2. Run $ docs/make clean to remove any docs previously built

3. Run $ docs/make html to build the docs in HTML format

4. Change the current directory to the location of the built docs by running $ cd docs/_build/html

5. Start the Python static files server by running $ python -m http.server

6. Visit localhost:8000 in your browser to view the docs

Generating the Documentation

1. Activate the development virtual environment

2. Generate the docs by running $ sphinx-apidoc -f -o docs/_sources . main.py manage.py *migrations* *tests*