File: install.rst

package info (click to toggle)
sphinxcontrib-spelling 2.1.1-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 368 kB
  • ctags: 89
  • sloc: python: 439; makefile: 148; sh: 18
file content (28 lines) | stat: -rw-r--r-- 571 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
.. .. spelling::

   wikis
   sphinxcontrib

==============
 Installation
==============

Installing sphinxcontrib.spelling
=================================

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

.. _PyEnchant: http://packages.python.org/pyenchant/

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

1. Add ``'sphinxcontrib.spelling'`` to the ``extensions`` list in ``conf.py``.

  ::

    extensions = [ 'sphinxcontrib.spelling' ]

.. _install-options: