User defined directives, roles, etc to ignore

I’m aware of #26 which added an example of registering a directive (which would allow full validation), but how about making it easy to ignore user defined lists of non-standard RST directives, roles, etc?

I am thinking along these lines, a recent change to my flake8-rst-docstrings (which calls into restructuredtext-lint to get docutils to validate RST extracted from docstrings in Python code):

https://github.com/peterjc/flake8-rst-docstrings/pull/16

As an aside, are substitutions common enough to need handling too? e.g. Using this for version seems quite common.

[peterjc]

Someone recently drew my attention to a similar tool called rstcheck which also wraps docutils for RST validation:

https://github.com/myint/rstcheck

This offers command line settings --ignore-directives and --ignore-roles as discussed here which can also be used via Python (and it has other ignore lists like substitutions).

The other big feature is it can check the syntax of some code blocks within the RST (e.g. a block of JSON or XML) - indeed this was originally the only thing this tool did back at v0.1 six years ago.

[AyanSinhaMahapatra]

I want to be able to use rst-lint as a quick check for a pre-commit hook and/or early step in continuous integration - with a dedicated continuous integration building the documentation later if that all seems fine (e.g. sphinx, which is slow).

Hi, I was also looking into rst-lint for similar requirements as @peterjc and it will be much appreciated.