tor-browser

The Tor Browser
git clone https://git.dasho.dev/tor-browser.git
Log | Files | Refs | README | LICENSE

rstlinter.rst (595B)


      1 RST Linter
      2 ==========
      3 
      4 `rstcheck`_ is a popular linter for restructuredtext.
      5 
      6 
      7 Run Locally
      8 -----------
      9 
     10 The mozlint integration of rst linter can be run using mach:
     11 
     12 .. parsed-literal::
     13 
     14    $ mach lint --linter rst <file paths>
     15 
     16 
     17 Configuration
     18 -------------
     19 
     20 All directories will have rst linter run against them.
     21 If you wish to exclude a subdirectory of an included one, you can add it to the ``exclude``
     22 directive.
     23 
     24 
     25 .. _rstcheck: https://github.com/myint/rstcheck
     26 
     27 
     28 Sources
     29 -------
     30 
     31 * :searchfox:`Configuration (YAML) <tools/lint/rst.yml>`
     32 * :searchfox:`Source <tools/lint/rst/__init__.py>`