build_docs.yml

name: Build and Deploy Docs
on:
  push:
    branches: [docs ]

  pull_request:
    branches: [release, docs ]
   # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:
  
  # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build_docs:
    name: Build Docs
    permissions:
      contents: read
      pull-requests: write
      id-token: write
      pages: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repo
        uses: actions/checkout@v3

      - name: Install Doxygen and Graphviz
        run:
          sudo apt-get install doxygen graphviz -y

      - name: Build Docs
        run: |
          cd docs
          doxygen Doxyfile
      
      - name: Setup Pages
        uses: actions/configure-pages@v5
        
      - name: Upload Docs
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/html
      
      - name: Deploy Docs
        id: deployment
        uses: actions/deploy-pages@v4