fix docstring #125
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 | |
| steps: | |
| - name: Install linux dependencies | |
| run: | | |
| sudo apt update | |
| sudo apt install -y optipng | |
| - uses: actions/checkout@v4 | |
| - uses: ./.github/actions/create-soundcard | |
| - uses: pyvista/setup-headless-display-action@v3 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.11 | |
| - uses: astral-sh/setup-uv@v4 | |
| - run: uv pip install --quiet --system .[doc] | |
| - run: stimuli sys-info --developer | |
| - run: make -C doc html | |
| - name: Prune sphinx environment | |
| run: rm -R ./doc/_build/html/.doctrees | |
| - 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 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: doc-dev | |
| path: ./doc-dev | |
| - 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 |