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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
.. spelling:word-list::
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 `GitHub site
<https://github.com/sphinx-contrib/spelling>`__.
Contributions in the form of patches or pull requests are easier to
integrate and will receive priority attention.
Running tests
=============
To run the tests, you need ``tox`` installed, then just run
``tox``. This should run the unit tests, the source code linter, and
try to build the current documentation.
Coding style
============
Python imports are formatted and sorted using `isort
<https://pycqa.github.io/isort/>`__. To format all files, run:
.. code-block:: console
$ tox -e style
Building Documentation
======================
The documentation for sphinxcontrib.spelling is written in
reStructuredText and converted to HTML using Sphinx. The build is
driven by ``tox``. To build only the documentation, run ``tox -e
docs``.
Contributing
============
Please submit changes as pull requests using the `GitHub repository
<https://github.com/sphinx-contrib/spelling>`__.
In the pull request description, link to any issues closed by the
changes using ``Fixes #NUM``, replacing ``NUM`` with the issue number.
Release Notes
=============
Please add a release note for each pull request to ``docs/history.rst``.
|
