name: Auto-build doxygen docs
on:
  push:
    branches:
      - master
      #! only for test, remove before MR !
      - doxygen
  
jobs:  
  doxygen:
    runs-on: ubuntu-24.04
    steps:
    - uses: actions/checkout@v4
      with:
        submodules: 'recursive'
        show-progress: ''
    - name: Setup and run doxygen
      run: sudo apt install doxygen graphviz qhelpgenerator-qt5 -y
    - name: Run doxygen
      run: doxygen Doxyfile
    - uses: actions/upload-pages-artifact@v3
      with: 
       path: ${{ github.workspace }}/doc/html/
    
    
  deploy:
    # Add a dependency to the build job
    needs: doxygen

    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      pages: write      # to deploy to Pages
      id-token: write   # to verify the deployment originates from an appropriate source

    # Deploy to the github-pages environment
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    # Specify runner + deployment step
    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4 # or specific "vX.X.X" version tag for this action