Sphinx "spelling" extension
Project description
This package contains sphinxcontrb.spelling, a spelling checker for Sphinx-based documentation. It uses PyEnchant to produce a report showing misspelled words.
Installation
Follow the instructions on the PyEnchant site to install enchant and then PyEnchant.
pip install sphinxcontrib-spelling
Configuration
Add 'sphinxcontrib.spelling' to the extensions list in conf.py.
extensions = [ 'sphinxcontrib.spelling' ]
Configuration Options
- spelling_show_suggestions
Boolean controlling whether suggestions for misspelled words are printed. Defaults to False.
- spelling_lang
String specifying the language, as understood by PyEnchant and enchant. Defaults to en_US for US English.
- spelling_word_list_filename
String specifying a file containing a list of words known to be spelled correctly but that do not appear in the language dictionary selected by spelling_lang. The file should contain one word per line. Refer to the PyEnchant tutoral for details.
Running
To process a document with the spell checker, use sphinx-build and specify spelling as the builder name using the -b option. The output includes the headings from the document and any misspelled words. If suggestions are enabled, they are shown on the same line as the misspelling.
$ sphinx-build -b spelling source output virtualenvwrapper Features - "Plugin" Introduction - "plugins" Details Installation Supported Shells - "bitbucket"
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for sphinxcontrib-spelling-0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c17d0276005b4178ca7b518f2ef44c146604cf51975726dada320a9ec7c1acb9 |
|
MD5 | 61568c088573d450de989f0032e70ad5 |
|
BLAKE2b-256 | d0bd52067f6ec56712a4e88f8b72b9e5329d3018105719cfc7172f89adbcde30 |