[pre-commit.ci] pre-commit autoupdate #88
Workflow file for this run
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 | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }} | |
| cancel-in-progress: true | |
| on: # yamllint disable-line rule:truthy | |
| pull_request: | |
| push: | |
| branches: [main] | |
| workflow_dispatch: | |
| jobs: | |
| build: | |
| timeout-minutes: 10 | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| shell: bash | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Python 3.11 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.11 | |
| - name: Install linux dependencies | |
| run: | | |
| curl -L https://github.com/sccn/liblsl/releases/download/v1.16.2/liblsl-1.16.2-jammy_amd64.deb -o liblsl-1.16.2-jammy_amd64.deb | |
| sudo apt update | |
| sudo apt install -y libpugixml-dev optipng | |
| sudo apt install -y ./liblsl-1.16.2-jammy_amd64.deb | |
| - name: Install package | |
| run: | | |
| python -m pip install --progress-bar off --upgrade pip setuptools | |
| python -m pip install --progress-bar off .[doc] | |
| - name: Display system information | |
| run: byte_triggers-sys_info --developer | |
| - name: Build doc | |
| run: make -C doc html | |
| - name: Prune sphinx environment | |
| run: rm -R ./doc/_build/html/.doctrees | |
| - name: Upload documentation | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: doc-dev | |
| path: ./doc/_build/html | |
| deploy: | |
| if: github.event_name == 'push' | |
| needs: build | |
| timeout-minutes: 10 | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| defaults: | |
| run: | |
| shell: bash | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Download documentation | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: doc-dev | |
| path: ./doc-dev | |
| - name: Deploy | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| folder: ./doc-dev | |
| target-folder: . | |
| git-config-name: 'github-actions[bot]' | |
| git-config-email: 'github-actions[bot]@users.noreply.github.com' | |
| single-commit: true | |
| force: true | |
| clean: true | |
| clean-exclude: | | |
| CNAME | |
| .nojekyll | |
| .gitignore |