Skip to content

Commit

Permalink
Add codespell to tox
Browse files Browse the repository at this point in the history
  • Loading branch information
cclauss committed Mar 2, 2022
1 parent e2f2ba2 commit 3cbfdd8
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 3 deletions.
1 change: 1 addition & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ jobs:
source $BASH_ENV
- run: tox -e migrations
- run: tox -e pre-commit
- run: tox -e codespell
- run: tox -e lint
- run: tox -e docs-lint
- run: tox -e docs
Expand Down
2 changes: 1 addition & 1 deletion readthedocs/search/tests/data/docs/support.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
{
"id": "usage-questions",
"title": "Usage Questions",
"content": "For help, Stack Overflow is the palce. Tag questions with read-the-docs so other folks can find them easily.. Good questions for Stack Overflow would be:. “What is the best way to structure the table of contents across a project?”. “How do I structure translations inside of my project for easiest contribution from users?”. “How do I use Sphinx to use SVG images in HTML output but PNG in PDF output?”"
"content": "For help, Stack Overflow is the place. Tag questions with read-the-docs so other folks can find them easily.. Good questions for Stack Overflow would be:. “What is the best way to structure the table of contents across a project?”. “How do I structure translations inside of my project for easiest contribution from users?”. “How do I use Sphinx to use SVG images in HTML output but PNG in PDF output?”"
},
{
"id": "community-support",
Expand Down
2 changes: 1 addition & 1 deletion readthedocs/search/tests/data/pipeline/signals.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@
],
"domain_data": {
"celery.worker.control.Panel": "Global registry of remote control commands",
"celery.platforms.Pidfile.remove_if_stale": "Remove the lock if the process isn’t running. I.e. process does not respons to signal"
"celery.platforms.Pidfile.remove_if_stale": "Remove the lock if the process isn’t running. I.e. process does not respond to signal"
}
}
3 changes: 3 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,6 @@ zip_safe = False
github_owner = readthedocs
github_repo = readthedocs.org

[codespell]
ignore-words-list = ba,configurtion,ded,hel,perfom,wile
skip = *.css,*.fjson,*.js,*.po,*.svg
8 changes: 7 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ commands =
export DJANGO_SETTINGS_MODULE=readthedocs.settings.proxito.test; \
pytest --cov-report= --cov-config {toxinidir}/.coveragerc --cov=. --cov-append -m proxito --suppress-no-test-exit-code {posargs}'

[testenv:codespell]
description = discover typos with codespell
deps = codespell
commands =
codespell --config={toxinidir}/setup.cfg

[testenv:docs]
description = Build readthedocs user documentation
changedir = {toxinidir}/docs
Expand Down Expand Up @@ -74,7 +80,7 @@ commands =
./manage.py makemigrations --check --dry-run

[testenv:docs-lint]
description = run linter (rstcheck) to ensure there aren't errors on our docs
description = "run linter (rstcheck) to ensure there aren't errors on our docs"
deps = -r{toxinidir}/requirements/docs.txt
changedir = {toxinidir}/docs
commands =
Expand Down

0 comments on commit 3cbfdd8

Please sign in to comment.