Skip to content

Commit

Permalink
add some instructions and example output to the spelling readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dhellmann committed Dec 28, 2010
1 parent 8eca452 commit 31e458d
Showing 1 changed file with 47 additions and 2 deletions.
49 changes: 47 additions & 2 deletions spelling/README
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,61 @@ showing misspelled words.
Installation
============

1.
1. Follow the instructions on the PyEnchant_ site to install enchant and then PyEnchant.
2. ``pip install sphinxcontrib-spelling``

Configuration
=============

1.
1. 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
<http://www.rfk.id.au/software/pyenchant/tutorial.html>`_ 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"

.. _PyEnchant: http://www.rfk.id.au/software/pyenchant/

0 comments on commit 31e458d

Please sign in to comment.