Test Coverage

The table below is generated automatically during the documentation build from coverage.xml. It reflects the latest metrics produced by pytest --cov.

Overall Test Coverage
Computed from coverage.xml during this build

Refreshing Coverage Data Locally

  1. Run the test suite with coverage enabled:

    poetry run pytest --cov --cov-report xml
    
  2. Rebuild the documentation so the coverage widget refreshes:

    make docs-build
    
  3. Commit both coverage.xml and the regenerated HTML snippet under docs/src/_generated/ if the numbers are expected to change.

CI and Read the Docs Integration

  • The GitLab pipeline publishes coverage artefacts that the docs job consumes.

  • On Read the Docs, a pre-build job executes the tests to ensure the include above always points at up-to-date figures.

  • Treat significant coverage drops as release blockers; they usually indicate missing test fixtures for new templates or generation behaviours.