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
29
30
31
|
.. .. spelling::
.. sphinxcontrib
.. reStructuredText
============
Developers
============
If you would like to contribute to sphinxcontrib.spelling directly,
these instructions should help you get started. Patches, bug reports,
and feature requests are all welcome through the `BitBucket site
<https://bitbucket.org/birkenfeld/sphinx-contrib/>`__.
Contributions in the form of patches or pull requests are easier to
integrate and will receive priority attention.
Building Documentation
======================
The documentation for sphinxcontrib.spelling is written in
reStructuredText and converted to HTML using Sphinx. The build itself
is driven by make. You will need the following packages in order to
build the docs:
- Sphinx
- docutils
- sphinxcontrib.spelling
Once all of the tools are installed into a virtualenv using
pip, run ``make html`` to generate the HTML version of the
documentation.
|
