.readthedocs.yml

# SPDX-License-Identifier: MPL-2.0

version: 2

# Note: PDF/epub/htmlzip output is not supported when using MkDocs
formats:
  - htmlzip
  - pdf
  - epub

build:
  os: ubuntu-24.04
  tools:
    python: "3.13"
  apt_packages:
    - wget
  jobs:
    pre_build:
      # upgrade to doxygen 1.16
      - wget https://www.doxygen.nl/files/doxygen-1.16.1.linux.bin.tar.gz
      - tar -xf doxygen-1.16.1.linux.bin.tar.gz
      # we cannot uninstall or replace the existing doxygen installed via apt
      # place the doxygen executable in the Python environment bin folder
      # the Python environment bin folder is located before the system paths in PATH
      - cp $PWD/doxygen-1.16.1/bin/doxygen $READTHEDOCS_VIRTUALENV_PATH/bin
      - doxygen --version
      - pwd
      - ls -la

sphinx:
  builder: html
  configuration: docs/source/conf.py
  fail_on_warning: false

python:
 install:
   - requirements: docs/requirements.txt

# see: https://docs.readthedocs.io/en/stable/config-file/v2.html#supported-settings