Let go of the 1-hour-long network request timeout to avoid frozen projects #162
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: "📚 API Documentation Builder" | |
| on: | |
| push: | |
| branches: | |
| - master | |
| pull_request: | |
| # Allow one concurrent deployment | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| build-docs: | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - name: 🐣 Checkout | |
| uses: actions/checkout@v6 | |
| - uses: actions/setup-python@v6 | |
| with: | |
| python-version: '3.13' | |
| - name: Install doxygen | |
| run: sudo apt install doxygen | |
| - name: Install mkdocs | |
| run: pip3 install jinja2 mkdocs ruamel.yaml mkdocs-material mkdoxy doxyqml --break-system-packages | |
| - name: Build documentation | |
| run: | | |
| mkdocs build -f mkdocs.yml | |
| # Beautify Q_INVOKABLE | |
| find ./site -type f -name "*.html" -exec sed -i 's/Q_INVOKABLE/<span style="font-weight:bold;">invokable<\/span>/g' {} + | |
| - name: Upload documentation | |
| uses: actions/upload-artifact@v5 | |
| if: ${{ github.event_name == 'pull_request' }} | |
| with: | |
| name: docs | |
| path: site | |
| if-no-files-found: error | |
| - name: Deploy to GitHub Pages | |
| if: contains(fromJSON('["push", "workflow_dispatch"]'), github.event_name) | |
| run: mkdocs gh-deploy --force |