README.md

Docs

This directory contains the files necessary to generate a Sphinx-based documentation website for this project:

Git LFS
- We use Git LFS to store the images in the docs; this is to avoid significant increases in the size of repo as we add and update images.
Node.js >= 16 to be able to view the output
Python 3.10 or later
Task >= 3.38.0
- We constrain the version because, in lower versions, the Taskfile syntax we use has bugs.

Build the site incrementally:
```
task docs:site
```
- The output of the build will be in ../build/docs/html.
Clean up the build:
```
task docs:clean
```

task docs:serve

The command above will install http-server and serve the built docs site; http-server will print the address it binds to (usually http://localhost:8080).