Local docs #216
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
| # This is a basic workflow to help you get started with Actions | |
| name: Doxygen Action | |
| # Controls when the action will run. | |
| on: | |
| # Trigger the workflow on pushes to the main or docs branches | |
| push: | |
| branches: [ main, docs ] | |
| # Trigger the workflow if a push is made to an open PR that edits certain files | |
| pull_request: | |
| paths: | |
| - '.github/workflows/doxygen.yml' | |
| - 'docs/Doxyfile' | |
| - 'docs/*.rst' | |
| - 'scripts/doxygen_prep.sh' | |
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | |
| jobs: | |
| # This workflow contains a single job called "build" | |
| build: | |
| # The type of runner that the job will run on | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| # Steps represent a sequence of tasks that will be executed as part of the job | |
| steps: | |
| # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | |
| - uses: actions/checkout@v2 | |
| - name: Preprocessing | |
| run: | | |
| for EXTENSION in cpp hpp ipp; do | |
| find . -name "*.${EXTENSION}" -exec scripts/doxygen_prep.sh {} \; | |
| done | |
| - name: Doxygen Action | |
| uses: mattnotmitt/doxygen-action@v1.1.0 | |
| with: | |
| # Path to Doxyfile | |
| doxyfile-path: "./Doxyfile" # default is ./Doxyfile | |
| # Working directory | |
| working-directory: "./docs" # default is . | |
| # tmate can be used to get an interactive ssh session to the GitHub runner | |
| # for debugging actions. See | |
| # [here](https://github.com/mxschmitt/action-tmate) for more information. | |
| # Uncomment these lines to debug the Doxygen build | |
| # - name: Setup tmate session | |
| # uses: mxschmitt/action-tmate@v3 | |
| - name: Deploy to GitHub Pages | |
| if: success() && (github.ref == 'refs/heads/main') | |
| uses: crazy-max/ghaction-github-pages@v2 | |
| with: | |
| target_branch: gh-pages | |
| build_dir: docs/html | |
| jekyll: false | |
| keep_history: false | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |