.readthedocs.yml

# .readthedocs.yaml
# 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: docs/source/conf.py

# Optionally build your docs in additional formats such as PDF and ePub
# formats:
#    - pdf
#    - epub

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# Specify dependencies to be installed
# Define the system dependencies
build:
  os: "ubuntu-20.04"
  tools:
    python: "3.9"
  apt_packages:
    - pandoc # Specify pandoc to be installed via apt-get
    - graphviz # Specify graphviz to be installed via apt-get
  jobs:
    pre_build:
      # Generate the Sphinx configuration for this Jupyter Book so it builds.
      - "jupyter-book config sphinx docs/source/"
      # Create font cache ahead of jupyter book
      - 'python -c "import matplotlib.pyplot as plt"'
      # Get the API documentation dynamically
      - "sphinx-apidoc -f -o docs/source/ src/caustics/"

python:
  install:
    - requirements: docs/requirements.txt # Path to your requirements.txt file
    - requirements: requirements.txt # Path to your requirements.txt file
    - method: pip
      path: . # Install the package itself