.readthedocs.yml

version: 2

build:
  os: ubuntu-22.04
  tools:
    python: "3.11"
  apt_packages:
    - tree
  jobs:
    post_create_environment:
      # Installing doesn't work; the wrong target is used even with 'virtualenvs.create false'. There is a GitHub issue
      # which may be a better solution in the future: https://github.com/python-poetry/poetry/issues/1937
      - curl -sSL https://install.python-poetry.org | POETRY_VERSION=1.8.2 python -
      - $HOME/.local/bin/poetry export --only=docs,manual-extras --without-hashes --output=requirements-from-poetry.txt
      - cat requirements-from-poetry.txt

    # pre_build:
    #   - python -m sphinx -b linkcheck docs/ _build/linkcheck  # Fails for valid GitHub links?

python:
  install:
    - requirements: requirements-from-poetry.txt
    - method: pip
      path: .
      extra_requirements:
        - plotting
        - cli

sphinx:
  configuration: docs/conf.py
  fail_on_warning: true

formats:
  - pdf

submodules:
  include: all