Check spelling with codespell, closes #307

This commit is contained in:
Simon Willison 2021-08-03 09:48:37 -07:00
commit 991cf56ae2
5 changed files with 31 additions and 5 deletions

25
.github/workflows/spellcheck.yml vendored Normal file
View file

@ -0,0 +1,25 @@
name: Check spelling in documentation
on: [push, pull_request]
jobs:
spellcheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: 3.9
- uses: actions/cache@v2
name: Configure pip caching
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install dependencies
run: |
pip install -e '.[docs]'
- name: Check spelling
run: codespell docs/*.rst --ignore-words docs/codespell-ignore-words.txt