pages.yaml

name: Docs on GH Pages

on:
  workflow_dispatch:
  push:
    paths-ignore:
      - .github/workflows/macos.yaml
      - .github/workflows/ubuntu.yaml
      - .github/workflows/windows.yaml
    branches:
      - main
  pull_request:
    paths-ignore:
      - .github/workflows/macos.yaml
      - .github/workflows/ubuntu.yaml
      - .github/workflows/windows.yaml
    branches:
      - main

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

jobs:
  build:
    runs-on: ubuntu-22.04
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Install ninja-build
        uses: seanmiddleditch/gha-setup-ninja@master
        with:
          version: 1.11.1
      - name: Install Sphinx
        run: pip install -r sphinx-requirements.txt
      - name: Configure documentation generation
        run: cmake --preset docs-ninja
      - name: Build documentation
        run: cmake --build --preset sphinx-docs
      - name: Upload artifact
        if: github.ref_name == github.event.repository.default_branch && github.event_name == 'push'
        uses: actions/upload-pages-artifact@v1
        with:
          path: ./build/docs/sphinx
  deploy:
    if: github.ref_name == github.event.repository.default_branch && github.event_name == 'push'
    concurrency:
      group: "pages"
      cancel-in-progress: true
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-22.04
    needs: [build]
    steps:
      - uses: actions/download-artifact@v3
        with:
          name: github-pages
      - name: Setup Pages
        uses: actions/configure-pages@v2
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1