Docs

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

• conf - Configuration files
• src - The actual docs

Requirements

• 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
• Task >= 3.48.0

Build Commands

• 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

Viewing the Output

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).