.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

build:
  os: ubuntu-22.04
  tools:
    python: "3.10"
  jobs:
    post_create_environment:
      # Install poetry
      # https://python-poetry.org/docs/#installing-manually
      - pip install poetry
    post_install:
      # Install dependencies with 'docs' dependency group
      # https://python-poetry.org/docs/managing-dependencies/#dependency-groups
      # VIRTUAL_ENV needs to be set manually for now.
      # See https://github.com/readthedocs/readthedocs.org/pull/11152/
      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with doc


# Build documentation in the "docs/" directory with Sphinx

sphinx:

  configuration: docs/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


# 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