Skip to content

Commit

Permalink
Add PySpelling support
Browse files Browse the repository at this point in the history
PySpelling is a python module for spell checking. It consumes Aspell or
Hunspell checking tools to catch misspelled words. This can be useful
during the core review.

Signed-off-by: Victor Morales <v.morales@samsung.com>
  • Loading branch information
electrocucaracha committed Sep 7, 2022
1 parent 46b7a81 commit e9571da
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .github/.wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
anuket
Baraque
Kubernetes
Lakelse
OpenStack
sexualized
Snezka
socio
tsc
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ doc/.DS_Store
_build/
.tox/
.vscode/
*.dic
21 changes: 21 additions & 0 deletions .spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
# SPDX-license-identifier: Apache-2.0
##############################################################################
# Copyright (c) 2022 Samsung Corporation
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################

matrix:
- name: markdown
dictionary:
wordlists:
- .github/.wordlist.txt
pipeline:
- pyspelling.filters.html:
sources:
- '_build/html/*.html'
aspell:
ignore-case: true
1 change: 1 addition & 0 deletions test-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
sphinx!=1.6.6,!=1.6.7,!=2.1.0,!=3.0.0,!=3.4.2 # BSD
doc8 # Apache-2.0
sphinx-material
pyspelling # MIT
1 change: 1 addition & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ deps =
commands =
sphinx-build --keep-going -W -T -b html -D language=en doc _build/html
sphinx-build --keep-going -W -b linkcheck doc _build/html
pyspelling -c .spellcheck.yml

0 comments on commit e9571da

Please sign in to comment.