Spell check reStructuredText.
Install with pip:
pip install spellrst
And download the spaCy model you want to use e.g. en_core_web_md
:
python -m spacy download en_core_web_md
After installing you can run spellrst
from the command line:
$ spellrst --help Usage: spellrst [OPTIONS] [FILES]... Spell check reStructuredText. Options: -d, --dictionary TEXT spaCy language model (spacy.io/models), e.g. en_core_web_md -c, --config TEXT Configuration file for a whitelist e.g. spellrst.toml --help Show this message and exit.
For example, to check all rst files contained in a directory (fish):
spellrst **.rst
To whitelist words, add them a TOML file.
By default spellrst
will read in spellrst.toml
if it exists in the current working directory.
In the TOML file, you can create a case-sensitive and/or case-insensitive list of words:
sensitive = ["reStructuredText", "Metaclass", "Jupyter"] insensitive = ["interactively"]
Here is the configuration for this project.