File: install.rst

package info (click to toggle)
sphinxcontrib-spelling 7.7.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 424 kB
  • sloc: python: 1,191; makefile: 151; sh: 27
file content (22 lines) | stat: -rw-r--r-- 486 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
 
.. spelling:word-list::

   sphinxcontrib

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

1. Install the extension with pip: ``pip install sphinxcontrib-spelling``

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

   .. code-block:: python

      extensions = [ 'sphinxcontrib.spelling' ]

3. Then pass ``"spelling"`` as the builder argument to ``sphinx-build``.

   .. code-block:: shell-session

      $ sphinx-build -b spelling docs/source docs/build