4c68ca682b
This for a few reasons: * The summary becomes the landing page for code quality: https://firefox-source-docs.mozilla.org/tools/static-analysis/summary.html * I don't think we need a full code quality category * Closer to the source-code-doc * All the files at the same place Differential Revision: https://phabricator.services.mozilla.com/D61767
33 lines
665 B
ReStructuredText
33 lines
665 B
ReStructuredText
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
|
|
-------
|
|
|
|
* `Configuration (YAML) <https://searchfox.org/mozilla-central/source/tools/lint/rst.yml>`_
|
|
* `Source <https://searchfox.org/mozilla-central/source/tools/lint/rst/__init__.py>`_
|