.readthedocs.yml

# .readthedocs.yml
# 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"

# Build documentation in the "docs" directory with Sphinx
sphinx:
  configuration: docs/conf.py
  fail_on_warning: true

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

# Optionally set the version of Python and requirements required to build your docs
python:
  install:
    - requirements: docs/requirements.txt
    - method: pip
      path: .
      extra_requirements:
        - docs

# Optionally build documentation from subdirectory
doc_path: docs

# Optionally include or exclude patterns
# exclude_patterns: []


# Optionally include additional paths
git:
  submodules: include
  submodules_recursive: true
  depth: 50

# Optionally set the default branch
default_branch: main

# Optionally set the language of your project
language: en

# Optionally set the conda environment to use
# conda:
#   environment: environment.yml

# Optionally specify the requirements file
# requirements_file: requirements.txt

# Optionally include additional build steps
# build:
#   image: latest

# Optionally specify the mkdocs configuration
# mkdocs:
#   configuration: mkdocs.yml
#   fail_on_warning: true