.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 version of Python and other tools we need
build:
  os: ubuntu-22.04
  apt_packages:
    - cmake
  tools:
    python: "3.12"
    rust: "1.75"
  jobs:
    post_install:
      # install featomic-torch with the CPU version of PyTorch. We can not use
      # the `python` section below since it does not allow to specify
      # `--extra-index-url`
      - pip install --extra-index-url https://download.pytorch.org/whl/cpu python/featomic_torch
    pre_build:
      # Pre-build Rust code here to avoid timeout when building docs
      - cargo build
      - cargo build --release
      - cargo doc -p featomic

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

# Declare the Python requirements required to build the docs
python:
   install:
   - method: pip
     path: .
   - requirements: docs/requirements.txt