update readme #9
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: Doxygen Documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| doxygen: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| - name: Set up Doxygen | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y doxygen graphviz | |
| - name: Generate Documentation | |
| run: | | |
| make docs | |
| - name: Deploy Documentation to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.PAT_TOKEN }} | |
| publish_dir: ./docs/html | |
| publish_branch: gh-pages | |
| - name: Clean up old docs | |
| run: | | |
| rm -rf ./docs/html/* |