spelling.rst

topic

Spelling Checker

triple: Sphinx; Extension; Spelling Checker

Spelling Checker

PyPI Package

https://pypi.org/project/sphinxcontrib-spelling/

Documentation

https://sphinxcontrib-spelling.readthedocs.io/

Git Repository

https://github.com/sphinx-contrib/spelling

Spelling checker for . It uses to produce a report showing misspelled words.

Features

1. Supports multiple source languages using the standard enchant dictionaries.
2. Supports project-specific dictionaries for localized jargon and other terminology that may not appear in the global dictionaries.
3. Suggests alternatives to words not found in the dictionary, when possible.

It consists:

• scspelling:index: spelling checker for

Private Dictionaries

For more details, see scspelling:customize section Private Dictionaries.

spelling_word_list_filename

That is a list specifying files containing a list of words known to be spelled correctly but that do not appear in the referred language dictionary. The files should contain one word per line. Refer to the tutorial for details.

\clearpage\phantomsection