merging doc CI #20
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: doc | |
| permissions: | |
| contents: write | |
| pages: write | |
| id-token: write | |
| on: | |
| # regenerate when master branch is updated | |
| push: | |
| branches: | |
| - master | |
| # or when manually triggered from the Actions tab | |
| workflow_dispatch: | |
| # prevent concurrent deployments | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| build-doc: | |
| name: Generation of documentation | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: obtain copy of repository | |
| uses: actions/checkout@v1 | |
| - name: run doxygen to generate doc, outputting to Doxygen_doc/html | |
| uses: mattnotmitt/[email protected] | |
| with: | |
| doxyfile-path: doxyconfig/config | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v3 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v2 | |
| with: | |
| # Upload Doxygen_doc/html | |
| path: ./Doxygen_doc/html | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v2 |