.readthedocs.yaml

# .readthedocs.yaml
version: 2

# Set the version of Python and other tools
build:
  os: ubuntu-22.04
  tools:
    python: "3.10"
  jobs:
    # Sets up Git LFS for large files, as shown in:
    # https://docs.readthedocs.io/en/stable/build-customization.html#support-git-lfs-large-file-storage
    post_checkout:
      # Download Git LFS
      - wget https://github.com/git-lfs/git-lfs/releases/download/v3.1.4/git-lfs-linux-amd64-v3.1.4.tar.gz
      - tar xvfz git-lfs-linux-amd64-v3.1.4.tar.gz
      # Modify LFS config paths to point where git-lfs binary was downloaded
      - git config filter.lfs.process "`pwd`/git-lfs filter-process"
      - git config filter.lfs.smudge  "`pwd`/git-lfs smudge -- %f"
      - git config filter.lfs.clean "`pwd`/git-lfs clean -- %f"
      # Make LFS available in current repository
      - ./git-lfs install
      # Download content from remote
      - ./git-lfs fetch
      # Make local files to have the real content on them
      - ./git-lfs checkout

python:
  install:
    - requirements: docs/requirements.txt
    - method: pip
      path: .


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