.readthedocs.yml

# Configuration on how ReadTheDocs (RTD) builds our documentation
# ref: https://readthedocs.org/projects/zero-to-jupyterhub/
# ref: https://docs.readthedocs.io/en/stable/config-file/v2.html

# Required (RTD configuration version)
version: 2

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

# Explicitly leave out PDF, ePub, htmlzip, etc so that we don't run into errors
# building our html based documentation which is whats really important.
#
# ref: https://github.com/pandas-dev/pydata-sphinx-theme/issues/177
formats: []

# Optionally set the version of Python and requirements required to build your docs
python:
  version: 3.8
  install:
    # WARNING: This requirements file will be installed without the pip
    #          --upgrade flag in an existing environment. This means that if a
    #          package is specified without a lower boundary, we may end up
    #          accepting the existing version.
    #
    #          ref: https://github.com/readthedocs/readthedocs.org/blob/0e3df509e7810e46603be47d268273c596e68455/readthedocs/doc_builder/python_environments.py#L335-L344
    - requirements: docs/requirements.txt