docs.yml

---
name: Docs

on:
    push:
        branches:
            - main
    pull_request:

concurrency:
    group: ${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}
    cancel-in-progress: true

jobs:
    build_images:
        uses: ./.github/workflows/build_images.yml
    docs:
        runs-on: ubuntu-22.04
        needs: [build_images]
        container:
            credentials:
                username: ${{ github.actor }}
                password: ${{ secrets.GITHUB_TOKEN }}
            image: ${{ needs.build_images.outputs.image_tag }}_gcc
        steps:
            - name: build_docs
              run: |
                  cmake -GNinja -B build -S /src
                  cmake --build build --target docs
            - name: upload
              uses: actions/upload-pages-artifact@v2
              with:
                  path: build/docs/sphinx_html/
    deploy_docs:
        if: ${{ github.ref == 'refs/heads/main' }}
        runs-on: ubuntu-22.04
        needs: [docs]
        environment:
            name: github-pages
            url: ${{ steps.deployment.outputs.page_url }}
        permissions:
            pages: write    # to deploy to Pages
            id-token: write # to verify the deployment originates from an appropriate source
        steps:
            - name: Deploy to GitHub Pages
              id: deployment
              uses: actions/deploy-pages@v2