reStructuredText

reStructuredText is supported through the external program rst2html. To get started, you’ll need to install the docutils package:

bash
Copy
$ pip install docutils

You’ll need to ensure that the rst2html executable is available in your $PATH (this should happen automatically).

The supported extensions are .rst and .rest.

By default, Vale ignores:

• Front matter: Blocks surrounded by --- or +++ delimiters.
• Literal blocks.
• Inline literals.
• URLs: See URL handling for more information.

Comments

Vale supports comment-based configuration in reStructuredText files:

• Turn Vale off entirely:

  rst
  Copy
  .. vale off
  
  This text will be ignored.
  
  .. vale on

• Turn off a specific rule:

  rst
  Copy
  .. vale Style.Redundancy = NO
  
  This is some text ACT test
  
  .. vale Style.Redundancy = YES

• Turn off specific match(es) within a rule:

  rst
  Copy
  .. vale Style.Redundancy["ACT test","OTHER"] = NO
  
  This is some text ACT test
  
  .. vale Style.Redundancy["ACT test","OTHER"] = YES

• Turn on or off specific styles:

  rst
  Copy
  .. vale StyleName1 = YES
  .. vale StyleName2 = NO

• Set styles (enabling them and switching off any other styles):

  rst
  Copy
  .. vale style = StyleName1
  .. vale styles = StyleName1, StyleName2