Documentation#
Our documentation is built on sphinx, is written using reStructuredText, and follows the Diátaxis framework.
To automatically re-build the documentation and serve it on an web server, you
can pass the serve
argument to the docs
nox task.
$ nox -s docs -- serve
When using this argument, the task will watch the documentation source files, and every time you edit something, it will automatically re-build the documentation and make it available on the provided web server.
Todo
Elaborate more with tips on how to write.