redoing PR #11
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: docs | |
| on: | |
| push: | |
| branches: | |
| - master | |
| paths: | |
| - ".doxyfile.in" | |
| - "CMakeLists.txt" | |
| - "README.md" | |
| - "doc/**" | |
| - "src/**" | |
| - ".github/workflows/docs.yml" | |
| pull_request: | |
| paths: | |
| - ".doxyfile.in" | |
| - "CMakeLists.txt" | |
| - "README.md" | |
| - "doc/**" | |
| - "src/**" | |
| - ".github/workflows/docs.yml" | |
| workflow_dispatch: | |
| inputs: | |
| deploy: | |
| description: "Deploy the generated docs to GitHub Pages" | |
| required: false | |
| default: false | |
| type: boolean | |
| permissions: | |
| contents: read | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install documentation dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y doxygen graphviz libyaml-cpp-dev | |
| - name: Configure CMake | |
| run: cmake -S . -B build -DBUILD_TESTS=OFF | |
| - name: Build documentation | |
| run: cmake --build build --target doc | |
| - name: Upload Pages artifact | |
| if: (github.event_name == 'push' && github.ref == 'refs/heads/master') || (github.event_name == 'workflow_dispatch' && inputs.deploy) | |
| uses: actions/upload-pages-artifact@v4 | |
| with: | |
| path: build/doxygen_html | |
| deploy: | |
| needs: build | |
| if: (github.event_name == 'push' && github.ref == 'refs/heads/master') || (github.event_name == 'workflow_dispatch' && inputs.deploy) | |
| runs-on: ubuntu-24.04 | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - uses: actions/configure-pages@v5 | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |