docs.yaml

name: Documentation

# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
  push:
    branches: [ master ]

jobs:
  build-documentation:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
      with:
        submodules: recursive
    
    - name: Create BUILD folder
      run: |
        mkdir -p ${{ github.workspace }}/BUILD

    # Build the HTML documentation
    - name: Doxygen Action
      uses: mattnotmitt/doxygen-action@v1.9.5
      with:
          doxyfile-path: ./doxyfile_options
    
    # Deploy the HTML documentation to GitHub Pages
    - name: GH Pages Deployment
      uses: peaceiris/actions-gh-pages@v3
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ./BUILD/html/
        enable_jekyll: false
        allow_empty_commit: false
        force_orphan: true
        publish_branch: docs-master