.readthedocs.yaml

# .readthedocs.yaml
# 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 you might need
build:
  os: ubuntu-22.04
  tools:
    python: "3.11"
  # These packages are needed to build docs with image optimization
  jobs:
    post_create_environment:
      # 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
    post_install:
      # Install dependencies with 'docs' dependency group
      # https://python-poetry.org/docs/managing-dependencies/#dependency-groups
      - poetry install --with docs
      # Using insiders versions of mkdocs-material & mkdocstrings
      - pip uninstall mkdocs-material mkdocstrings mkdocstrings-python -y
      - pip install git+https://$GH_TOKEN@github.com/squidfunk/mkdocs-material-insiders.git@9.5.36-insiders-4.53.13
      - pip install git+https://$GH_TOKEN@github.com/pawamoy-insiders/mkdocstrings-python.git
      - pip install mkdocs-jupyter # This is bugged, I enforced it manually, let's see if it works

  apt_packages:
    - libcairo2-dev
    - libfreetype6-dev
    - libffi-dev
    - libjpeg-dev
    - libpng-dev
    - libz-dev
    - pngquant

mkdocs:
  configuration: mkdocs.yml

# If using Sphinx, optionally build your docs in additional formats such as PDF
formats:
  - pdf