mirror of
https://github.com/simonw/datasette.git
synced 2025-12-10 16:51:24 +01:00
Spelling corrections plus CI job for codespell
* Use codespell to check spelling in documentation, refs #1417 * Fixed spelling errors spotted by codespell, closes #1417 * Make codespell a docs dependency See also this TIL: https://til.simonwillison.net/python/codespell
This commit is contained in:
parent
54b6e96ee8
commit
2208c3c68e
12 changed files with 42 additions and 16 deletions
25
.github/workflows/spellcheck.yml
vendored
Normal file
25
.github/workflows/spellcheck.yml
vendored
Normal 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
|
||||
Loading…
Add table
Add a link
Reference in a new issue