.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:
  image: latest

# Optionally set the version of Python and requirements required
# to build docs
python:
  version: "3.9"
  install:
    # On https://readthedocs.org/dashboard/ansible-lint/environmentvariables/ we
    # do have PIP_CONSTRAINTS=.config/constraints.txt which ensures we install only
    # pinned requirements that that we know to be working.
    - method: pip
      path: .
      extra_requirements:
        - docs
  system_packages: false