NAME¶

rstcheck - check syntax of reStructuredText files and nested code blocks

SYNOPSIS¶

DESCRIPTION¶

rstcheckvalidates the syntax of reStructuredText files and can also verify the syntaxfor a number of languages in nested code blocks:

• Bash
• Doctest
• C (C99)
• C++ (C++11)
• JSON
• XML
• Python
• restructuredTest

OPTIONS¶

--config FILE

load configuration fromFILE.The configuration is expected in INI file format with a section[rstcheck]and key-value pairs which correspond with command line options.

-r, --recursive

Treat input file names as directories and recursively check all.rstfiles within.

--report LEVEL

restrict reported severities toLEVELor higher.Valid levels in increasing order of severity are:info, warning, error, severe.You can also specifynoneto suppress all output.

--ignore-language LANG, --ignore LANG

Ignore code blocks with one of the languagesLANG,whereLANGis a comma-separated list of code block language identifiers. You can alsodisable language checking with a block comment such as

.. rstcheck: ignore-language=cpp,python,rst
    

near the beginning of the input file.

--ignore-messages (MSG)

Ignore all messages that match the regular expressionMSG.Note that you will probably need to quote the regex to prevent spuriousshell expansion:

"(Title underline too short.*|Duplicate implicit target.*)"
    

--ignore-directivesDIR

Ignore any rST directives from the comma-separated listDIR.

--ignore-substitutionsSUB

Ignore any rST substitutions from the comma-separated listSUB.

--ignore-rolesROLES

Ignore any rST roles from the comma-separated listROLES.

INTEGRATIONWITHVIM¶

You can instructSyntasticto check.rstfiles withrstchecklike this:

let g:syntastic_rst_checkers = ['rstcheck']

ALE will detect the presence ofrstcheckautomatically, no additional configuration is required.

AUTHOR¶

rstcheckwas written by Steven Myint. This manual page was written byTimo Röhlingfor Debian and may be reused without restriction.