documentation.yml

name: Build Documentation with Sphinx and Deploy to Pages

on:
  push:
    branches: ["master"]

  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          cache: 'pip'
          cache-dependency-path: '${{ github.workspace }}/doc/requirements.txt'
      - run: python -m pip install --upgrade pip
      - name: Install Python Dependencies
        run: python -m pip install -r ${{ github.workspace }}/doc/requirements.txt
      - name: Install Doxygen
        uses: ssciwr/doxygen-install@v1
        with:
          version: "1.10.0"
      - name: Configure CMake
        run: cmake -B ${{ github.workspace }}/build -S ${{ github.workspace }}
      - name: Build Documentation
        run: cmake --build ${{ github.workspace }}/build --target documentation
      - name: Setup Pages
        uses: actions/configure-pages@v5
      - name: Upload Artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ${{ github.workspace }}/build/doc/root
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4