docs.yml

name: Docs

on:
  push:
    branches: [main]
  # Allow manual trigger from the Actions tab
  workflow_dispatch:

# Only one docs deploy at a time — cancel any in-progress run on the same branch
concurrency:
  group: docs-${{ github.ref }}
  cancel-in-progress: true

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest

    permissions:
      contents: write   # needed to push to gh-pages

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Install Doxygen and Graphviz
        run: |
          sudo apt-get update -qq
          sudo apt-get install -y doxygen graphviz
          doxygen --version

      - name: Generate documentation
        run: doxygen Doxyfile

      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: docs/doxygen/html
          # Keep the gh-pages branch history lean
          force_orphan: true
          # Optional: add a .nojekyll file so GitHub Pages serves files
          # starting with _ (Doxygen uses _static etc.)
          enable_jekyll: false