.readthedocs.yaml

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

# to build documentation locally, use "python setup.py build_sphinx --build-dir build/source" command from root of directory
# command will create a folder called build/source and place .html and .doctree files in their respective folders.

# Required
version: 2

# Additional formats of the documentation to be built, apart from the default HTML.
formats: []

# Create a conda environment, using the file below, to build documentation on ReadtheDocs
#conda:
#    environment: docs/environment.yml # if using a conda virtual environment must specify "miniconda3-4.7" in build.tools.python

# Build documentation in the docs/ directory with Sphinx
sphinx:
#   builder: html
   configuration: docs/source/conf.py #The path to the conf.py file, relative to the root of the project.
#  fail_on_warning: true

# Set the version of Python and other tools you might need
build:
  os: ubuntu-22.04
  tools:
    python: "3.8"
#    python: "miniconda3-4.7" #this is specifically required if using a conda environment (to build documentation) and you want to specify build.jobs.

# Optionally declare the Python requirements required to build your docs
python:
  install:
    - requirements: docs/requirements.txt
    - method: pip
      path: .