Skip to main content

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.


  1. Follow the instructions on the PyEnchant site to install enchant and then PyEnchant.

  2. pip install sphinxcontrib-spelling


  1. Add 'sphinxcontrib.spelling' to the extensions list in

extensions = [ 'sphinxcontrib.spelling' ]

Configuration Options


Boolean controlling whether suggestions for misspelled words are printed. Defaults to False.


String specifying the language, as understood by PyEnchant and enchant. Defaults to en_US for US English.


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.


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


 - "Plugin"

 - "plugins"



   Supported Shells
   - "bitbucket"

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxcontrib-spelling-0.1.tar.gz (6.8 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page