.readthedocs.yaml

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

# Required
version: 2
# Set the OS, Python version and other tools you might need
build:
  os: ubuntu-22.04
  tools:
    python: "3.12"
  apt_packages:
    - doxygen
  jobs:
    # build-customization -> https://docs.readthedocs.io/en/stable/build-customization.html
    pre_build:
      - echo "installing dev dependencies"
      - python -m pip install -e ".[dev]"
      - echo "installing doc dependencies"
      - python -m pip install -e ".[docs]"
      - echo "doxygen build"
      - cd docs && doxygen Doxyfile
# Build documentation in the "docs/" directory with Sphinx
sphinx:
  configuration: docs/conf.py
  # fail on warning is disabled because sphinx does not support "requires" from cpp20 see: https://github.com/sphinx-doc/sphinx/issues/7296
  # we should reenable when/if sphinx fixes that
  # fail_on_warning: true
# Optionally build your docs in additional formats such as PDF and ePub
formats:
  - pdf

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
#    install:
#      - requirements: docs/requirements.txt