RSTCHECK(1)

🎀 RSTCHECK — the manual page, bestie edition 🎀

okay so you found the rstcheck(1) page and it's giving very much "text processing tools" energy. let's get into it 💅

---

✨ NAME ✨

rstcheck — check the syntax of reStructuredText files, and also of the nested code blocks hiding inside them 🦋

---

✨ SYNOPSIS ✨

         [--ignore-messages MSG] [--ignore-directives DIR]
         [--ignore-substitutions SUB] [--ignore-roles ROLES] FILE.rst
         [FILE.rst ...]

---

✨ DESCRIPTION ✨

So basically rstcheck is out here validating the syntax of your reStructuredText files — and not just the rST itself, no ma'am. It can also vibe-check the syntax of a whole bunch of languages that show up in your nested code blocks 👑

The languages it can check are:

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

periodt. that's the list. 💖

---

✨ OPTIONS ✨

• --config FILE — loads your config from FILE. The config is expected to be in INI file format, with a section called [rstcheck] and key-value pairs that correspond with the command line options. iykyk 🌸
• -r, --recursive — treats the input file names as directories and recursively checks every .rst file inside them. it's giving "do the whole folder, not just one file" ✨
• --report LEVEL — restricts the reported severities to LEVEL or higher. the valid levels, in increasing order of severity, are: info, warning, error, severe. you can also say none to suppress all output entirely. no thoughts, no output 💀
• --ignore-language LANG, --ignore LANG — ignore code blocks with one of the languages in LANG, where LANG is a comma-separated list of code block language identifiers. you can ALSO disable language checking with a block comment, like this:

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

placed near the beginning of the input file. two ways to do the same thing, slay 🫶

• --ignore-messages (MSG) — ignore all messages that match the regular expression MSG. heads up bestie: you will probably need to quote the regex so your shell doesn't do spurious expansion on you 😭 like:

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

• --ignore-directivesDIR — ignore any rST directives from the comma-separated list DIR.
• --ignore-substitutionsSUB — ignore any rST substitutions from the comma-separated list SUB.
• --ignore-rolesROLES — ignore any rST roles from the comma-separated list ROLES.

---

✨ INTEGRATION WITH VIM ✨

You can tell Syntastic to check .rst files with rstcheck like this:

let g:syntastic_rst_checkers = ['rstcheck']

And ALE? ALE will detect the presence of rstcheck automatically — no additional configuration required. it just knows. main character energy fr fr 👑

---

✨ AUTHOR ✨

rstcheck was written by Steven Myint. This manual page was written by Timo Röhling for Debian and may be reused without restriction. 🫶

---

and that's the whole page, no cap 💖 this was version 6.2.4+~1.2.1 of the rstcheck(1) manual — go forth and check your rST, bestie 🦋✨