.readthedocs.yaml

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

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
  os: ubuntu-22.04
  tools:
    python: "3.11"
#  jobs:
#    post_create_environment:
#      # Install poetry
#      # https://python-poetry.org/docs/#installing-manually
#      - POETRY=/home/docs/.local/bin/poetry make install-poetry
##      - 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/
#      - POETRY=/home/docs/.local/bin/poetry VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH make install-packages
##      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --extras "crypto" --with docs
  commands:
      - POETRY=/home/docs/.local/bin/poetry make install-poetry
      - POETRY=/home/docs/.local/bin/poetry make install
      - POETRY=/home/docs/.local/bin/poetry make docs
      - ls -l ./docs/_build/html/*
      - mkdir --parents $READTHEDOCS_OUTPUT/html/
      - cp --recursive ./docs/_build/html/* $READTHEDOCS_OUTPUT/html/
#  jobs:
#    pre_create_environment:
#      # Select Python version (keep in sync with other versions):
#      - asdf install python 3.11.5
#      - asdf global python 3.11.5
#      - python -m pip install --upgrade --no-cache-dir virtualenv
#
#      # Install poetry:
#      - asdf plugin add poetry
#      - asdf install poetry 1.5.1
#      - asdf global poetry 1.5.1
#      - 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
#      - make install

# Build documentation in the "docs/" directory with Sphinx
sphinx:
  configuration: docs/conf.py
  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
  # builder: "dirhtml"
  # Fail on all warnings to avoid broken references
  # fail_on_warning: true

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

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
#python:
#  install:
#    - method: pip
#      path: .
#      extra_requirements:
#        - docs