add instructions on spelling check using sphinxcontrib-spelling #487
Conversation
facebook-github-bot
added
the
CLA Signed
|
@zycalice has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
| @@ -95,6 +95,32 @@ Run following command from `website` folder. It will build the docs and serve th | |||
| ./scripts/build_website.sh | |||
| ``` | |||
|
|
|||
| You can also perform spell checks on documentation automatically (besides IDEs) using [```sphinxcontrib-spelling```](https://sphinxcontrib-spelling.readthedocs.io/en/latest/install.html) | |||
There was a problem hiding this comment.
Would it be possible to add spell check as an automated linter Eg: https://github.com/marketplace/actions/github-spellcheck-action ?
^ This uses PySpelling and I am not sure if it is compatible with all the files we have.
Co-authored-by: Karthik Prasad <prasadkr@uci.edu>
|
@zycalice has updated the pull request. You must reimport the pull request before landing. |
|
@facebook-github-bot has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
|
@zycalice has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
|
@zycalice has updated the pull request. You must reimport the pull request before landing. |
|
@facebook-github-bot has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
Types of changes
Motivation and Context / Related issue
Add instruction on how to run spell checks using
sphinxcontrib.spellingfor files build with sphinx.Related to #380
How Has This Been Tested (if it applies)
Checklist