docs.yml

# Simple workflow for deploying static content to GitHub Pages
name: Build project docs

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]
  pull_request:

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Python install
        uses: actions/setup-python@v5
        with:
          python-version: '3.13'
      - name: Poetry setup
        uses: Gr1N/setup-poetry@v9
      - run: poetry install --with=docs
      - name: Build the docs
        run: make docs
      - name: Upload artifact to github pages
        uses: actions/upload-pages-artifact@v3
        with:
          path: 'docs/build/html'
  deploy:
    if: github.ref == 'refs/heads/main'
    needs: build
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Setup Pages
        uses: actions/configure-pages@v5
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4