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"
History
- 0.2
Warn but otherwise ignore unknown node types.
- 0.1
First public release.
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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 24c4805d92f0b0c507834475a11e685d17e3e79a16ac7e789155fcab1e7cc338 |
|
MD5 | a538063c6be177975fa08d1cb0975f20 |
|
BLAKE2b-256 | 60d3b19a4654df443cfa4cc05492ed6531a2ccbc5ff23e8f3c5e32b499229402 |