Possible to ignore other reStructuredText directives/roles?

[jdillard]

In the docs for reStructuredText, it mentions:

Vale ignores literal blocks, inline literals, and code-blocks by default.

Does by default imply there is a way to ignore other reStructuredText directives? I'm guessing not, but I thought I would start by asking. If it's possible to implement, it would be nice to ignore directives/roles such as math, but I understand there might be limitations from the parser.

edit: I'm guessing the logic would be somewhere in here: https://github.com/errata-ai/vale/blob/v2/internal/lint/rst.go

[jdkato]

You can do this with a BlockIgnores pattern:

[*]
BasedOnStyles = Vale

BlockIgnores = (?s) *(\.\. math::)

[jdillard]

Thanks! And if I want to ignore :math: roles as well it seems this is the syntax?

BlockIgnores = (?s) *(\.\. math::), (?s) *(:math:`.*`)

Edit: Actually, it seems I should be using TokenIgnores for inline markup:

BlockIgnores = (?s) *(\.\. math::)
TokenIgnores = (:math:`.*`)

Also, if you think it would be useful to add an example of ignoring additional directives/roles using BlockIgnores to the reStructuredText section in the docs, I can make a PR for that. Or maybe just a link to Non-standard markup.

[jdkato]

Yep, TokenIgnores are for inline markup.

Feel free to submit a PR with examples.