Skip to content

Keep spellchecking local and run lint in CI #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
drbruced12 merged 7 commits into from
Sep 28, 2026
Merged

Keep spellchecking local and run lint in CI #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ca28c10
add correct entry to dict
Walentalien Sep 26, 2026
dd875d0
make spellcheck fail on reported words
Walentalien Sep 26, 2026
2a02a3f
run checks on push to main
Walentalien Sep 26, 2026
24e50e3
add dict entry
Walentalien Sep 26, 2026
c23be84
add temp diagnostics script
Walentalien Sep 26, 2026
062421f
remove test from ci
Walentalien Sep 28, 2026
058c91a
run only lint in ci, do not rely on spellcheck
Walentalien Sep 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/validate-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
- name: Check out repo
uses: actions/checkout@v6
- name: Validate source
run: make test
run: make lint
- name: Build html
run: make html
- name: List built files
Expand Down
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ lint: $(VIRTUALENV)
doc8 --ignore-path $< --ignore-path "$(BUILDDIR)" --max-line-length 120 .

# Workaround sphinx-doc/sphinx#4371.
spelling: SPHINXOPTS += -E
spelling: SPHINXOPTS += -E -W

# clean up
clean:
Expand Down
2 changes: 2 additions & 0 deletions dict.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,7 @@ cyber
cybersecurity
cyclocross
Daemen
dahl
DARPA
datacenter
datacenter's
Expand Down Expand Up @@ -1232,6 +1233,7 @@ Ott
OTT
Ousterhoust
Ousterhout
outsized
overcommit
overfit
overfitting
Expand Down
Loading