Skip to content

Commit

Permalink
Add a simple spellchecker to weed out common typos etc. in the docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
jonasbardino committed Apr 2, 2024
1 parent 24a59c6 commit d1108dc
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ on:
- 'doc/**'
- '1.gocd.yml'
- '.gitignore'
- '.spellcheck.yml'
- '.spellcheckwordlist.txt'

push:
branches:
Expand Down
31 changes: 31 additions & 0 deletions .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Spell Checking
on:
pull_request:
types:
- opened
- reopened
- synchronize
branches:
- master
paths-ignore:
- '**/*.py'
- '**/*.yml'
- '.gitignore'

push:
branches:
- master
tags:
- v**

jobs:
check-spelling:
runs-on: ubuntu-latest
steps:
- name: Check out repository contents
uses: actions/checkout@v3
- name: Check Spelling of docs
uses: rojopolis/[email protected]
with:
config_path: .spellcheck.yml
task_name: Markdown
17 changes: 17 additions & 0 deletions .spellcheck-wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
MiGrid
MiG
ERDA
SIF
HPC
docker
podman
ansible
centos
rocky
sftp
ftps
webdavs
openid
seafile
jupyter
duplicati
27 changes: 27 additions & 0 deletions .spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
matrix:
- name: Markdown
expect_match: false
aspell:
mode: en
dictionary:
wordlists:
- .spellcheck-wordlist.txt
output: wordlist.dic
encoding: utf-8
pipeline:
- pyspelling.filters.markdown:
markdown_extensions:
- markdown.extensions.extra:
- pyspelling.filters.html:
comments: false
attributes:
- alt
ignores:
- ':matches(code, pre)'
- 'code'
- 'pre'
- 'blockquote'
sources:
- '*.md'
- 'doc/source/**/*.md'
default_encoding: utf-8

0 comments on commit d1108dc

Please sign in to comment.