Publish Documentation #4
This file contains 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: Publish Documentation | |
| on: | |
| release: | |
| types: [published] | |
| workflow_dispatch: # Allows manual triggers from GitHub UI | |
| jobs: | |
| build-and-deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Generate Documentation | |
| uses: mattnotmitt/doxygen-action@edge | |
| with: | |
| working-directory: './docs' | |
| doxyfile-path: './doxygen-configFile' | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/build/html | |
| force_orphan: true # keeps gh-pages branch clean | |
| commit_message: "docs: update doxygen documentation" |