.readthedocs.yaml

# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
#
# It references dev/mkdocs.yml for the MkDocs configuration

version: 2

# Build configuration
build:
  os: ubuntu-24.04
  tools:
    python: "3.11"
  commands:
    # Explicitly install dependencies first (python.install may not run before commands)
    - pip install -r dev/requirements-rtd.txt
    # Install the project itself (needed for mkdocstrings to parse code)
    - pip install -e .
    # Use the patched build script to ensure i18n plugin works correctly
    # This applies patches to mkdocs-static-i18n before building
    - python dev/build_docs_patched_clean.py

# MkDocs configuration
# Point to the mkdocs.yml file in the dev directory
# Note: We override the default build with build.commands above,
# but this is still needed for Read the Docs to detect MkDocs project
mkdocs:
  configuration: dev/mkdocs.yml

# Python environment configuration
# These steps run BEFORE build.commands
python:
  install:
    # Install dependencies from requirements file (relative to project root)
    - requirements: dev/requirements-rtd.txt
    # Install the project itself (needed for mkdocstrings to parse code)
    # Use editable install to ensure imports work correctly
    - method: pip
      path: .
      extra_requirements: []

# Format configuration (optional, for better build output)
formats:
  - htmlzip
  - pdf