github-pages.yaml

name: GitHub Pages

on:
  push:
    branch:
      - main

jobs:
  deploy:
    runs-on: ubuntu-22.04

    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      contents: read
      pages: write      # to deploy to Pages
      id-token: write   # to verify the deployment originates from an appropriate source

    # Deploy to the github-pages environment
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    concurrency:
      group: ${{ github.workflow }}-${{ github.ref }}

    steps:
      - uses: actions/checkout@v4

      - name: Setup Python
        uses: actions/setup-python@v3
        with:
          python-version: '3.10'

      - name: Upgrade pip
        run: |
          python3 -m pip install --upgrade pip

      - name: Install dependencies
        run: python3 -m pip install sphinx

      - name: Make the sphinx docs
        run: |
          make -C . clean
          make -C . html

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          # Upload entire repository
          path: 'build/html/'

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1