Skip to content

How to regenerate the autogenerated diagrams

Prerequisites:

  • Create and activate a Python virtual environment (venv) from the project root:
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  • Install the project development Python requirements (contains pyreverse via the pylint package) in the activated venv. See requirements-dev.txt:
pip install -r requirements-dev.txt
  • System tools required: graphviz (provides dot). Optional fallback tools: imagemagick (convert) and potrace.

Generate the SVGs locally with:

./scripts/generate-diagrams.sh

Notes:

  • The CI/docs workflow regenerates these SVGs automatically; the repository ignores the generated SVGs (docs/reference/diagrams/*.svg) and intermediate files (*.dot, *.pnm).
  • If you want to keep the intermediate DOT files for inspection, edit scripts/generate-diagrams.sh and disable the cleanup step.