.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-20.04
  tools:
    python: "3.9"
    # You can also specify other tool versions:
    # nodejs: "16"
    # rust: "1.55"
    # golang: "1.17"
  commands:
    - pip install poetry==1.8.2
    - poetry config virtualenvs.create false
    - poetry install --with docs
    - mkdir -p $READTHEDOCS_OUTPUT/html/
    - poetry run sphinx-build -b html docs/source $READTHEDOCS_OUTPUT/html/
  # jobs:
  #   post_create_environment:
  #     # Install poetry
  #     # https://python-poetry.org/docs/#installing-manually
  #     - pip install poetry==1.8.2
  #     # 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
    

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

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

# Optionally declare the Python requirements required to build your docs
# python:
#    install:
#    - method: pip
#      path: .