Documentation¶
Building Documentation¶
Activate the development virtual environment
Change the current directory to the docs folder within the repository by running
$ cd docs
Run
$ ./make clean
to remove any docs previously builtRun
$ ./make html
to build the docs in HTML formatChange the current directory to the location of the built docs by running
$ cd _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 -o docs .