.readthedocs.yaml

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

version: 2

build:
  os: ubuntu-22.04
  tools:
    python: "3.8"
  # jobs:
  #   post_checkout:
  #     # Cancel building pull requests when there aren't changed in the docs directory or YAML file.
  #     #
  #     # If there are no changes (git diff exits with 0) we force the command to return with 183.
  #     # This is a special exit code on Read the Docs that will cancel the build immediately.
  #     - |
  #       if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/master -- docs/ mkdocs.yml .readthedocs.yaml;
  #       then
  #         exit 183;
  #       fi
  # Workaround for https://github.com/readthedocs/readthedocs.org/issues/10013
  commands:
    - pip install -r docs/requirements.txt
    - mkdocs build --clean --site-dir ./_readthedocs/html --config-file mkdocs.yml

python:
  install:
    - requirements: docs/requirements.txt

mkdocs:
  configuration: mkdocs.yml