Documentation

Build the documentation locally

It is good practice to verify that the documentation builds successfully.

To build the documentation, you additionally need the Graphviz tool. It is provided by standard package managers on Linux. On macOS, it needs to be installed either using MacPorts or Homebrew.

You need

poetry run make -C docs clean html

then open the built website.

xdg-open docs/build/html/index.html # Linux
open docs/build/html/index.htmlxdg-open docs/build/html/index.html # macOS