.readthedocs.yaml

# .readthedocs.yaml
# Read the Docs configuration file
# Modified from example provided by readthedocs
# 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.9"

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

# Disabled until emoji safety for each formant is better understood.
# PDF's LaTeX-based pipeline fails when encountering any, and epub's
# build was cancelled because of it.
# formats:
#   - pdf
#   - epub

# TL;DR for contributors:
# 1. Install using pip install -e .[dev,docs]
# 2. Whenever you update deps, pip-compile --extras docs -o docs/requirements.txt pyproject.toml to freeze all deps

# Based on recommendations from readthedocs at:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html

python:
    install:
    - requirements: docs/requirements.txt