Updated comments for doxygen #4
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Generate Doxygen Documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repo | |
| uses: actions/checkout@v3 | |
| - name: Install Doxygen and Graphviz | |
| run: sudo apt-get update && sudo apt-get install -y doxygen graphviz | |
| - name: Run Doxygen | |
| run: doxygen Doxyfile | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/doxygen | |
| publish_branch: gh-pages | |
| user_name: 'github-actions[bot]' | |
| user_email: 'github-actions[bot]@users.noreply.github.com' | |
| commit_message: 'Update Doxygen documentation' | |
| keep_files: false # DON'T keep previous files | |
| force_orphan: true # Optional: force orphan branch for fresh history | |
| enable_jekyll: false # No Jekyll on gh-pages | |
| - name: Enable GitHub Pages via API | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| curl -X POST \ | |
| -H "Authorization: token $GITHUB_TOKEN" \ | |
| -H "Accept: application/vnd.github.v3+json" \ | |
| https://api.github.com/repos/${{ github.repository }}/pages \ | |
| -d '{"source":{"branch":"gh-pages","path":"/"}}' |