readthedocs.yml

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

# Version of config file (required)
version: 2

# Set the version of Python and other tools you might need
build:
  os: ubuntu-22.04
  tools:
    python: "3.11"

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

# Optionally build your docs in additional formats such as PDF and ePub
formats:
  - pdf

# we do not use conda anymore because it consumes too much memory and thus crashes our builds
# see:
# - https://docs.readthedocs.io/en/stable/guides/build-using-too-many-resources.html#use-pip-when-possible
# - https://github.com/readthedocs/readthedocs.org/issues/6692
#conda:
#  environment: doc/environment.yml

# Optionally declare the Python requirements required to build your docs
python:
  install:
    - requirements: doc/requirements.txt
    - method: pip
      path: .