.readthedocs.yaml

# Read the Docs configuration file for Sphinx projects
# 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
# see https://docs.readthedocs.io/en/stable/guides/conda.html
build:
  os: ubuntu-22.04
  tools:
    # need to use mamba 1.55 because of a bug in earlier versions
    # https://github.com/readthedocs/readthedocs.org/issues/11416#issuecomment-2201305755
    python: "mambaforge-23.11"

conda:
  environment: docs/environment.yml
  
# Build documentation in the "docs/" directory with Sphinx
sphinx:
  configuration: docs/source/conf.py
  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
  # builder: "dirhtml"
  # Fail on all warnings to avoid broken references
  # fail_on_warning: true

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