rstcheck #453
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: rstcheck | |
# Run this workflow for commits to doc files | |
on: | |
push: | |
paths: | |
- ".github/workflows/rstcheck.yml" | |
- "README.rst" | |
- "docs/**" | |
- "ci/rstcheck/*" | |
pull_request: | |
paths: | |
- ".github/workflows/rstcheck.yml" | |
- "README.rst" | |
- "docs/**" | |
- "ci/rstcheck/*" | |
permissions: | |
contents: read | |
jobs: | |
rstcheck: | |
name: rstcheck | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout code | |
uses: actions/[email protected] | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.11 | |
- name: Install Python dependencies | |
run: | | |
python -m pip install -r ci/rstcheck/requirements.txt | |
- name: Run rstcheck | |
run: | | |
rstcheck -r --ignore-directives automodule --ignore-substitutions version,release,today . |