Documentation: Implement automatic spelling check #77
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR solves issue #76 by implementing an automatic spell checking for the documentation using pyspelling instead of sphinxcontrib.spelling.
Changes Introduced
docs/Makefile
to include:aspell
andpyspelling
across common operating systems.spellingcheck.yaml
: Configurespyspelling
to check built HTML files, excluding pages like glossary, index, and style guide.docs/wordlist.txt
, a custom dictionary of valid project-specific terms.pyproject.toml
to include pyspelling as a documentation dependency..gitignore rules
to exclude docs/wordlist.dic.contributing/index.rst
: