# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
  os: ubuntu-26.04
  tools:
    python: "3.14"
    # Note this must be at least the go version from test/tools/go.mod in order to be able to build swagger.
    golang: "1.25"
  jobs:
    pre_build:
      - make swagger
      - mv pkg/api/swagger.yaml docs/source/_static/swagger.yaml

# Build documentation in the docs/ directory with Sphinx
sphinx:
  configuration: docs/source/conf.py

# Optionally build your docs in additional formats
formats:
  - htmlzip
  - epub
  - pdf

# We recommend specifying your dependencies to enable reproducible builds:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
  install:
  - requirements: docs/requirements.txt