Skip to content

Commit 8245fff

Browse files
authored
docs: enable SymSpell for documentation spell checking (#550)
1 parent 2f97edd commit 8245fff

File tree

3 files changed

+4
-2
lines changed

3 files changed

+4
-2
lines changed

docs/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ charset-normalizer==3.4.4 ; python_version >= "3.10" and python_version < "3.15"
77
click==8.3.1 ; python_version >= "3.10" and python_version < "3.15"
88
codespell==2.4.1 ; python_version >= "3.10" and python_version < "3.15"
99
colorama==0.4.6 ; python_version >= "3.10" and python_version < "3.15"
10+
editdistpy==0.2.0 ; python_version >= "3.10" and python_version < "3.15"
1011
editorconfig==0.17.1 ; python_version >= "3.10" and python_version < "3.15"
1112
ghp-import==2.1.0 ; python_version >= "3.10" and python_version < "3.15"
1213
griffe==1.15.0 ; python_version >= "3.10" and python_version < "3.15"
@@ -50,6 +51,7 @@ setuptools==80.10.2 ; python_version >= "3.10" and python_version < "3.15"
5051
six==1.17.0 ; python_version >= "3.10" and python_version < "3.15"
5152
soupsieve==2.8.3 ; python_version >= "3.10" and python_version < "3.15"
5253
super-collections==0.6.2 ; python_version >= "3.10" and python_version < "3.15"
54+
symspellpy==6.9.0 ; python_version >= "3.10" and python_version < "3.15"
5355
termcolor==3.3.0 ; python_version >= "3.10" and python_version < "3.15"
5456
tomli==2.4.0 ; python_version >= "3.10" and python_version < "3.15"
5557
typeguard==4.4.4 ; python_version >= "3.10" and python_version < "3.15"

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ plugins:
149149
known_words: known_words.txt
150150
skip_files: [CHANGELOG.md, reference/*]
151151
backends:
152-
# - symspellpy # TODO: add this back once https://github.com/mammothb/editdistpy/issues/21 is resolved, then rerun `tox run -e export-reqs` to update docs/requirements.txt
152+
- symspellpy
153153
- codespell:
154154
dictionaries:
155155
- clear

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ pydantic = "^2.12.5"
146146
pygments = "^2.17.2"
147147
pymdown-extensions = "^10.8.1"
148148
requests = "^2.31.0"
149-
# symspellpy = "^6.7.7" # TODO: add this back once https://github.com/mammothb/editdistpy/issues/21 is resolved, then rerun `tox run -e export-reqs` to update docs/requirements.txt
149+
symspellpy = "^6.7.7"
150150
tomli = "^2.0.1"
151151

152152
[tool.poetry.group.tests.dependencies]

0 commit comments

Comments
 (0)