Merge pull request #32 from xLPMG/develop #194
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
| ## | |
| # @author Luca-Philipp Grumbach, Richard Hofmann | |
| # @section DESCRIPTION | |
| # Build the documentation using GitHub Actions. | |
| ## | |
| name: Build documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| jobs: | |
| build: | |
| runs-on: macos-latest | |
| if: github.ref == 'refs/heads/main' | |
| steps: | |
| - name: Requirements | |
| run: brew install doxygen | |
| && brew install sphinx-doc | |
| && pip3 install sphinx-rtd-theme | |
| && pip3 install breathe | |
| && pip3 install sphinx-sitemap | |
| - name: Checkout repo | |
| uses: actions/[email protected] | |
| - name: Build docs | |
| run: cd docs | |
| && make html | |
| && cd build/html | |
| && touch .nojekyll | |
| - name: Deploy to GitHub Pages | |
| uses: JamesIves/[email protected] | |
| with: | |
| BRANCH: gh-pages # The branch the action should deploy to. | |
| FOLDER: docs/build/html # The folder the action should deploy. |