readthedocs.yml

version: 2

sphinx:
  builder: html
  configuration: source/conf.py
  fail_on_warning: true

build:
  os: ubuntu-24.04
  tools:
    python: "3.13"
  apt_packages:
    - librsvg2-bin
  jobs:
    post_checkout:
      - git fetch --unshallow || true
    pre_create_environment:
      - asdf plugin add uv
      - asdf install uv latest
      - asdf global uv latest
    create_environment:
      - uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
    install:
      - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen
    build:
      htmlzip:
        - mkdir --parents _readthedocs/htmlzip
        # Output to an intermediate directory because RTD doesn't like extra content in the directory. $READTHEDOCS_PROJECT is chosen to so that frc-docs-latest is the root directory of the zip
        - python -m sphinx -T -W --keep-going -b readthedocssinglehtmllocalmedia -d _build/doctrees -D language=$READTHEDOCS_LANGUAGE source $READTHEDOCS_OUTPUT/$READTHEDOCS_PROJECT
        - cd $READTHEDOCS_OUTPUT ; zip --recurse-path --symlinks htmlzip/$READTHEDOCS_PROJECT.zip $READTHEDOCS_PROJECT

formats:
  - htmlzip
  - pdf