doc-gen.yml

name: Deploy static documentation on Pages

on:
  push:
    branches: ["*"]
  workflow_dispatch:

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

jobs:
  # Single deploy job since we're just deploying
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3

      - name: Run Doc generation script
        run: doc/generate.bash

      - name: Fix permissions
        run: sudo chmod -c -R +rX 'doc/docs-site/build'

      - name: Setup Pages
        uses: actions/configure-pages@v3

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v2
        with:
          path: 'doc/docs-site/build/site/'

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