Skip to content

ClearlyOps Documentation

This site is built from code and docstrings. The generated references are the only source of truth for API and configuration details.

Generated references

  • docs/generated/api_reference.md is derived from the FastAPI OpenAPI schema.
  • docs/generated/config_env.md is derived from api/config.py.

Do not edit generated files directly. Update code or docstrings and rerun:

python scripts/generate_docs.py