docs.yml

# This workflow builds the Sphinx documentation, and in doing so - checks for errors in the documentation.
name: Docs

on:
  push:
  pull_request:
    types: [opened, reopened]
  workflow_dispatch:

permissions:
  contents: read

jobs:
  docs:
    name: Test Docs
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v5

      - name: Setup Python 3.10
        uses: actions/setup-python@v6
        with:
          python-version: "3.10"
          cache: "pip" # Cache the pip packages to speed up the workflow

      - name: Install Dependencies and Package
        run: |
          python -m pip install -U pip setuptools
          pip install -U -r requirements.txt
          pip install -e .[docs]

      - name: Build Documentation
        run: |
          cd docs
          sphinx-build -b html -j auto -a -n -T -W --keep-going . _build/html