Correct Python cancellation and cleanup docs #39
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: Docs PR checks | |
| on: | |
| pull_request: | |
| branches: [main] | |
| paths: | |
| - 'src/**' | |
| - 'docs/**' | |
| - 'overrides/**' | |
| - 'mkdocs.yml' | |
| - 'pyproject.toml' | |
| - 'scripts/check-docs-analytics.py' | |
| - 'scripts/check-docs-layout.py' | |
| - 'scripts/docstring_cross_references.py' | |
| - '.github/workflows/docs-pr.yml' | |
| - '.github/workflows/docs.yml' | |
| permissions: | |
| contents: read | |
| concurrency: | |
| group: docs-pr-${{ github.event.pull_request.number }} | |
| cancel-in-progress: true | |
| jobs: | |
| validate: | |
| name: Build and check the developer portal | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 15 | |
| steps: | |
| - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6 | |
| - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6 | |
| with: | |
| python-version: "3.12" | |
| - name: Install package and documentation dependencies | |
| run: pip install -e '.[docs]' | |
| - name: Install Chromium | |
| run: python -m playwright install --with-deps chromium | |
| - name: Build and check the portal | |
| run: | | |
| mkdocs build --strict | |
| python scripts/docstring_cross_references.py --site site | |
| python scripts/check-docs-analytics.py site | |
| python scripts/check-docs-layout.py site |