blob: 46a68d584937467b22ada7c894df407f8367b0e8 (
plain)
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
|
RST Linter
==========
`rstcheck`_ is a popular linter for restructuredtext.
Run Locally
-----------
The mozlint integration of rst linter can be run using mach:
.. parsed-literal::
$ mach lint --linter rst <file paths>
Configuration
-------------
All directories will have rst linter run against them.
If you wish to exclude a subdirectory of an included one, you can add it to the ``exclude``
directive.
.. _rstcheck: https://github.com/myint/rstcheck
Sources
-------
* :searchfox:`Configuration (YAML) <tools/lint/rst.yml>`
* :searchfox:`Source <tools/lint/rst/__init__.py>`
|
