build-docs.yaml

name: Build API Docs

on:
  push:
    branches: [ "main" ]

# Give the default GITHUB_TOKEN write permission to commit and push 
# the docs files to the repository and allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write
  
# 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
  
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  build-docs:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    
    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
    - name: Checkout
      uses: actions/checkout@v4
      with:
        submodules: recursive
    - name: Generate Documentation
      uses: mattnotmitt/doxygen-action@v1.9.5
      with:
        working-directory: "."
        doxyfile-path: "./docs/dependencies/Doxyfile"
    - name: Setup Pages
      uses: actions/configure-pages@v4
    - name: Upload artifact
      uses: actions/upload-pages-artifact@v3
      with:
        # Upload docs repository
        path: "./docs/"
    - name: Deploy to GitHub Pages
      id: deployment
      uses: actions/deploy-pages@v4