.readthedocs.yaml

# Copyright 2021 Agnostiq Inc.
#
# This file is part of Covalent.
#
# Licensed under the GNU Affero General Public License 3.0 (the "License").
# A copy of the License may be obtained with this software package or at
#
#      https://www.gnu.org/licenses/agpl-3.0.en.html
#
# Use of this file is prohibited except in compliance with the License. Any
# modifications or derivative works of this file must retain this copyright
# notice, and modified files must contain a notice indicating that they have
# been altered from the originals.
#
# Covalent is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the License for more details.
#
# Relief from the License may be granted by purchasing a commercial license.

# .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:
  configuration: doc/source/conf.py

# Optionally set the version of Python and requirements required to build your docs
python:
  install:
    - requirements: requirements.txt
    - requirements: doc/autodoc_executor_plugins_requirements.txt
    - requirements: doc/requirements.txt
    - method: pip
      path: .
    - method: pip
      path: .
    - method: pip
      path: .

build:
  os: "ubuntu-22.04"
  tools:
    python: "3.8"
  jobs:
    # This for dependency pinning because readthedocs.yml automically updates all libraries despite being pinned.
    # See: https://github.com/readthedocs/readthedocs.org/issues/9752#issuecomment-1324778813
    post_install:
      # Botocore from AWS executors requrires urllib3<1.27,>=1.25.4
      - pip install urllib3==1.26.6
      # For covalent slurm plugin
      - pip install aiofiles==0.8.0