DOC: Added alt text to n-back tutorial #66
Workflow file for this run
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: Test build of html and latex documentation | |
| # will run in root folder devops/devops/ | |
| # and we will create the following (which will persist until next run): | |
| # - ./docs/python #executable | |
| # - psychopy #repo | |
| # - devops #repo | |
| on: | |
| workflow_dispatch: # manual | |
| inputs: | |
| pp_branch: | |
| description: 'PsychoPy branch to build docs from' | |
| required: true | |
| default: 'dev' | |
| type: choice | |
| options: | |
| - dev | |
| - release | |
| pull_request: | |
| branches: [release, dev] | |
| permissions: | |
| contents: write | |
| jobs: | |
| build_docs: | |
| runs-on: [windows-latest] | |
| defaults: | |
| run: | |
| shell: bash | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.10"] | |
| steps: | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install UV | |
| uses: astral-sh/setup-uv@v7 | |
| with: | |
| activate-environment: true | |
| - name: Select branch | |
| run: | | |
| if [ "${{ github.event_name }}" == "workflow_dispatch" ]; then | |
| echo "Manual trigger for branch: ${{ github.event.inputs.pp_branch }}" | |
| branch="${{ github.event.inputs.pp_branch }}" | |
| else | |
| echo "Scheduled trigger, using release branch" | |
| branch="release" | |
| fi | |
| # export for other steps | |
| echo "BRANCH=$branch" >> $GITHUB_ENV | |
| - name: Checkout psychopy | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: psychopy/psychopy | |
| path: psychopy | |
| ref: ${{ env.BRANCH }} | |
| - name: Checkout psychopy-docs | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: psychopy/psychopy-docs | |
| path: docs | |
| ref: ${{ env.BRANCH }} | |
| - name: Install psychopy and dependencies | |
| working-directory: docs | |
| run: | | |
| ls | |
| # workaround for dukpy | |
| uv pip install git+https://gitlab.com/peircej/metapensiero.pj.git # includes fixes since last release | |
| # install psychopy depends for docs (incl sphinx extensions) | |
| uv pip install -e ".[tests]" ".[plugins]" --upgrade | |
| - name : Update alerts | |
| working-directory: docs | |
| run: | | |
| echo "\n Create Alerts documentation:" | |
| python updateAlerts_rst.py | |
| - name: Sphinx build html | |
| working-directory: docs | |
| run: | | |
| sphinx-build -b html source build/html | |
| - name: Sphinx build latex | |
| working-directory: docs | |
| run: | | |
| sphinx-build -b latex source build/latex | |
| - name: Upload html docs as artifact | |
| uses: actions/upload-artifact@v6 | |
| with: | |
| name: psychopy-docs-html | |
| path: docs/build/html |