gh-pages.yml

name: Publish Documentation

on:
  workflow_call:
  workflow_dispatch:

jobs:

  build-documentation:
    runs-on: ubuntu-24.04
    permissions:
      contents: read
    steps:
      - name: SCM Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Setup Python & Poetry Environment
        uses: ./.github/actions/python-environment

      - name: Build Documentation
        run: |
          poetry run -- nox -s docs:multiversion
          rm -r .html-documentation/*/.doctrees

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: .html-documentation

  deploy-documentation:
    needs: [ build-documentation ]
    permissions:
      contents: read
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-24.04
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4