ci.yml

# Test that the documentation can be built, saving an archive of the built documentation for a number of days
name: CI
on:
  # Triggers the workflow for any push or any pull_request
  push:
  pull_request:
  # Allows you to run this workflow manually from the actions tab
  workflow_dispatch:

jobs:
  # This workflow contains a single job called "build"
  build:
    # Define environment variables in the job
    env:
      # When building on RTD, conf.py has some conditional logic. Test building with this enabled.
      READTHEDOCS: "True"

    # Run on the latest ubuntu images
    runs-on: ubuntu-latest

    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - uses: actions/checkout@v4

      - uses: "actions/setup-python@v5"
        with:
          python-version: "3.12"

      - name: "Install dependencies"
        run: pip install -r requirements.txt

      - name: "Build docs"
        run: sphinx-build -W . ./html

      - name: Archive built docs
        uses: actions/upload-artifact@v3
        with:
          name: docs
          path: html