.readthedocs.yml

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

---
# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
  # keep dirhtml for nice URLs without .html extension
  builder: dirhtml
  configuration: docs/conf.py
  fail_on_warning: true

# Build documentation with MkDocs
#mkdocs:
#  configuration: mkdocs.yml
#  fail_on_warning: true

# Optionally build your docs in additional formats
# such as PDF and ePub
formats: []

submodules:
  include: all # []
  exclude: []
  recursive: true

build:
  # when using pre_build, "image:" is not supported and os and tools are required
  os: ubuntu-20.04
  tools:
    python: "3.10"
  jobs:
    pre_build:
      - pip install '.[docs,test]'
      - ansible-lint -L -f docs
# Optionally set the version of Python and requirements required
# to build docs
# python:
#   version: "3.8"
#   install:
#     # On https://readthedocs.org/dashboard/ansible-lint/environmentvariables/ we
#     # do have PIP_CONSTRAINTS=requirements.txt which ensures we install only
#     # pinned requirements that that we know to be working.
#     - method: pip
#       path: .
#       extra_requirements:
#         - docs
#         - test
#   system_packages: false