compile.sh

#!/bin/bash
# Demonstrates how to compile the documentation for local testing

# Check dependencies are installed
if [[ $(uname) == 'Linux' ]]; then
  if [[ ! $(which python3) ]]; then
    echo "Could not find python3-venv on the PATH."
    echo "Try: apt install python3-venv"
    exit 1
  fi
fi

if [[ ! $(which pip3) ]]; then
  echo "Could not find pip3 on the PATH."
  echo "Try: apt install python3-pip"
  exit 1
fi

# Create a Python virtual environment if needed
if [[ ! -d venv ]]; then
    python3 -m venv venv
fi

# Activate the virtual environment
source venv/bin/activate

# Install the Python requirements on the virtual environment
if [[ -f requirements.txt ]]; then
  pip install -r requirements.txt
else
  echo "The requirements.txt file is not present, exiting"
  exit 1
fi

# Compile the documentation
make html linkcheck