# 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.12"
    # You can also specify other tool versions:
    # nodejs: "20"
    # rust: "1.70"
    # golang: "1.20"
  jobs:
    install:
    - python -m pip install --upgrade --no-cache-dir pip setuptools
    - python -m pip install --upgrade --upgrade-strategy only-if-needed --no-cache-dir --group doc .

# Build documentation in the "doc/" directory with Sphinx.
sphinx:
  configuration: doc/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: all