Reference#
The CLI, configuration and environment-variable pages are generated from the source on every build, so they cannot drift from the code you have installed.
CLI — every command and flag, from the Typer application
Configuration — every YAML field, from the Pydantic models
Environment variables — every variable, from the
SettingsmodelPython API — the four public objects, curated
Release notes — the changelog
The Python API pages are deliberately not generated over the whole package.
Only the names exported from domyn_swarm are documented; everything else is
internal and may change without notice.