.readthedocs.yml

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

# Required
version: 2

# Set the version of Python and other tools you might need
build:
  os: ubuntu-22.04
  tools:
    python: "3.11"

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

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

# Optionally build your docs in additional formats such as PDF
# Disabled due to: https://github.com/readthedocs/readthedocs.org/issues/10015
# formats:
#   - pdf

# Optionally set the version of Python and requirements required to build your docs
python:
  install:
    - requirements: docs/requirements.txt
    - method: pip
      path: rastervision_pipeline/
    - method: pip
      path: rastervision_aws_s3/
    - method: pip
      path: rastervision_aws_batch/
    - method: pip
      path: rastervision_core/
    - method: pip
      path: rastervision_pytorch_learner/
    - method: pip
      path: rastervision_pytorch_backend/
    - method: pip
      path: rastervision_aws_sagemaker/

# https://docs.readthedocs.io/en/stable/config-file/v2.html#search
search:
  ranking:
    # down-rank source code pages
    _modules/*: -10