update docs #14
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: Generate Doxygen Documentation | |
| on: | |
| push: | |
| branches: | |
| - main # Generate docs when pushing to the main branch | |
| pull_request: | |
| branches: | |
| - main # Optionally generate docs for PRs | |
| jobs: | |
| generate-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Step 1: Checkout the repository | |
| - name: Checkout Repository | |
| uses: actions/checkout@v3 | |
| # Step 2: Set up Doxygen | |
| - name: Install Doxygen | |
| run: sudo apt-get install -y doxygen graphviz | |
| # Step 3: Generate Documentation | |
| - name: Generate Doxygen Documentation | |
| run: doxygen docs/configs/Doxyfile | |
| # Step 4: Deploy to GitHub Pages (optional) | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/output/html | |
| publish_branch: gh-pages |