Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What has been built?
This PR adds MVP-level functionality to use the sphinx spelling extension as a spell checker.
How was it done?
sphinxcontrib.spellingwas added as an extension in_conf.ymlspelling_correctwords.txtwas added to the root that contains words that should be skipped by spell checkHow can it be tested?
Run the instructions below (copied from the README):
pip install sphinxcontrib-spelling-- this installs the proper module in the environmentjupyter-book config sphinxgeneratesconf.py-- this creates a file (conf.py) that will allow us to bypassjupyter-book build .and run the sphinx build command directlyconf.py: -- these are our custom configuration settings for the modulesphinx-build -b spelling . ./_buildfrom root (this is in place ofjupyter-book build .-- This builds the book while checking for spelling. The output of this build includes locations of spelling errors detected in the text