Build documentation #2
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
| ## | |
| # @author Lucas Obitz, Luca-Philipp Grumbach | |
| # @section DESCRIPTION | |
| # Build the documentation using GitHub Actions. | |
| ## | |
| name: Build documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| jobs: | |
| build: | |
| runs-on: ubuntu-24.04-arm | |
| steps: | |
| - name: Checkout Repository | |
| uses: actions/[email protected] | |
| - name: Install Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.13' | |
| - name: Install Other Requirements | |
| run: sudo apt-get install -y doxygen | |
| && cd docs | |
| && sudo pip install -r requirements.txt | |
| - name: Build docs | |
| run: cd docs | |
| && make html | |
| && cd build/html | |
| && touch .nojekyll | |
| - name: Deploy to GitHub Pages | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| branch: gh-pages | |
| folder: docs/build/html |