.readthedocs.yml

# ----------------------------------------------------------------------------
# Read the Docs configuration file
# ============================================================================
# https://docs.readthedocs.io/en/stable/config-file/v2.html for details
#
# Example projects:
# https://docs.readthedocs.io/en/stable/examples.html
#
# Automated latest, stable, and previous versions:
# https://docs.readthedocs.io/en/stable/versions.html
# https://docs.readthedocs.io/en/stable/integrations.html
# https://docs.readthedocs.io/en/stable/automation-rules.html
#
# Best practices:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# https://docs.readthedocs.io/en/stable/guides/best-practice/links.html
#
# --- Connecting Read the Docs with Sphinx/PyData ---
#
# Reference for readthedocs-hosted PyData docs to allow auto-versioning:
# https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/index.html
#
# Corresponding config file 'pydata-sphinx-theme/readthedocs.yml':
# https://github.com/pydata/pydata-sphinx-theme/blob/main/readthedocs.yml
#
# ----------------------------------------------------------------------------

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
  os: ubuntu-22.04
  # os: ubuntu-latest
  tools:
    python: "3.10"
  jobs:
    post_install:
      # - pip install sphinx furo pydata-sphinx-theme numpydoc autodoc_pydantic
      - pip install -r requirements_docs.txt
      - pip install -r requirements.txt
      - pip install -r requirements_optional.txt
      - pip install --editable .

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

# Optionally build your docs in additional formats such as PDF and ePub
formats:
  - htmlzip
  - 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:
   ## - sphinx furo pydata-sphinx-theme numpydoc autodoc_pydantic
   ## - method: pip
   # - requirements: docs/requirements.txt