Metadata-Version: 1.1
Name: sphinxcontrib-spelling
Version: 0.2
Summary: Sphinx "spelling" extension
Home-page: http://bitbucket.org/birkenfeld/sphinx-contrib
Author: Doug Hellmann
Author-email: doug.hellmann@gmail.com
License: BSD
Download-URL: http://pypi.python.org/pypi/sphinxcontrib-spelling
Description: =========================
         sphinxcontrib-spelling
        =========================
        
        This package contains sphinxcontrb.spelling, a spelling checker for
        Sphinx-based documentation.  It uses PyEnchant_ to produce a report
        showing misspelled words.
        
        Installation
        ============
        
        1. Follow the instructions on the PyEnchant_ site to install enchant and then PyEnchant.
        2. ``pip install sphinxcontrib-spelling``
        
        Configuration
        =============
        
        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"
        
        History
        =======
        
        0.2
          Warn but otherwise ignore unknown node types.
        
        0.1
          First public release.
        
        .. _PyEnchant: http://www.rfk.id.au/software/pyenchant/
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
