2.1. Spelling Checker¶
- PyPI Package
- Documentation
- Git Repository
Spelling checker for Sphinx. It uses PyEnchant to produce a report showing misspelled words.
- Features
Supports multiple source languages using the standard enchant dictionaries.
Supports project-specific dictionaries for localized jargon and other terminology that may not appear in the global dictionaries.
Suggests alternatives to words not found in the dictionary, when possible.
It consists:
sphinxcontrib.spelling: spelling checker for Sphinx
2.1.1. Private Dictionaries¶
For more details, see Configuration Options section Private Dictionaries.
-
.. spelling::
¶ The
.. spelling::
directive can be used to create a list of words known to be spelled correctly within a single file. For example, if a document refers to a person or project by name, the name can be added to the list of known words for just that single document.When a more common list of words is needed, related to check multiple document at once, the
spelling_word_list_filename
variable should be set properly.