Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spell check #7

Open
rwegener2 opened this issue Mar 19, 2022 · 0 comments
Open

Spell check #7

rwegener2 opened this issue Mar 19, 2022 · 0 comments

Comments

@rwegener2
Copy link
Owner

rwegener2 commented Mar 19, 2022

There are a lot of spelling errors in the repo (See #15, #16, #17, ... 😅), and it would be great to enable a spell checker to help catch these and other spelling errors.

Sphinx has a spelling extension that might work for this project:

https://sphinxcontrib-spelling.readthedocs.io/en/latest/

The installation instructions for the extension are here. This project is using Juptyer Book which is built on top of sphinx, so we will be modifying the setup slightly following the Advanced Sphinx usage section of the jupyter book docs. Once its installed we can try to run the spell check as described here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant