.readthedocs.yaml

# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

build:
  os: "ubuntu-24.04"
  tools:
    python: "3.11"
  jobs:
    post_checkout:
      - git clone -n --depth=1 --filter=tree:0 https://github.com/AstarVienna/irdb ./docs/source/examples/inst_pkgs
      - git -C ./docs/source/examples/inst_pkgs sparse-checkout set --no-cone Armazones ELT METIS MICADO MORFEO LFOA !docs
      - git -C ./docs/source/examples/inst_pkgs checkout
      - find . -name \*.ipynb -type f -print
    post_create_environment:
      # Install poetry
      # https://python-poetry.org/docs/#installing-manually
      - pip install poetry
    post_install:
      # Install dependencies with 'docs' dependency group
      # https://python-poetry.org/docs/managing-dependencies/#dependency-groups
      # VIRTUAL_ENV needs to be set manually for now.
      # See https://github.com/readthedocs/readthedocs.org/pull/11152/
      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs
      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry run pip install ScopeSim_Templates
      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry run pip install git+https://github.com/AstarVienna/ScopeSim_Data.git

sphinx:
  configuration: docs/source/conf.py

formats:
  - pdf
  - epub