.readthedocs.yml

# .readthedocs.yml
# Read the Docs configuration file

# Details
# - https://docs.readthedocs.io/en/stable/config-file/v2.html
# - https://docs.readthedocs.io/en/stable/build-customization.html#install-dependencies-with-poetry

# Required
version: 2

build:
  os: "ubuntu-22.04"
  tools:
    python: "3.10"

  # https://docs.readthedocs.io/en/stable/build-customization.html#extend-the-build-process
  jobs:
    post_install:

      # setuptools has been downgraded to 58.2.0, so upgrade again.
      - pip install --upgrade setuptools

      # Install Poetry.
      # https://python-poetry.org/docs/#installing-manually
      - pip install poetry

      # Tell Poetry to not use a virtual environment.
      - poetry config virtualenvs.create false

      # Install project's dependencies.
      - .github/workflows/install.sh docs

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

# Optionally build your docs in additional formats such as PDF
formats:
  - pdf