Skip to content

Conversation

@tkknight
Copy link
Contributor

Adopted the use of sphinxcontrib-spelling extension to check for spelling mistakes.

A dependency named sphinxcontrib-spelling needs to be added to the requirements but cannot be resolved right at this moment.

To benefit from this as is, this PR has many spelling mistakes corrected but the actual spelling extension is disabled. Once the dependency in the requirement is in place it may enabled.

When enabled, it will allow:

  • To be run using 'make spelling' in the documentation directory
  • To be run as part of the travis-ci job (new sub task). Will need to check it will fail the travis job is a spelling issue is identified
  • A file named spelling_allow.txt contains a list of all allowed words that are not in the dictionary. There are many as there are many technical terms and acronyms that are used in the documentation.

…mentation (sphinxcontrib-spelling). Includes all the spelling corrections.
@tkknight tkknight linked an issue Aug 10, 2020 that may be closed by this pull request
2 tasks
@tkknight tkknight changed the title Put in place spell checker for the sphinx documentation Spell checker for the sphinx documentation (not enabled for now) Aug 10, 2020
@tkknight tkknight marked this pull request as ready for review August 10, 2020 15:23
@tkknight tkknight requested a review from bjlittle August 10, 2020 15:23
* master:
  Correct links in docs (SciTools#3781)
  [PI-3478] Merge cube arithmetic feature branch (SciTools#3785)
@bjlittle
Copy link
Member

bjlittle commented Aug 15, 2020

@tkknight Awesome, once we solve the dependence for pyenchant then we can turn this on 🤟👍

@bjlittle bjlittle merged commit 8c171e9 into SciTools:master Aug 15, 2020
tkknight added a commit to tkknight/iris that referenced this pull request Aug 16, 2020
…haul

* upstream/master:
  Removed redundant whatsnew test. (SciTools#3784)
  Fixed typo (SciTools#3783)
  Spell checker for the sphinx documentation (not enabled for now) (SciTools#3779)
@tkknight tkknight deleted the spell_check_framework branch September 10, 2020 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Automate a spell checker for the documentation

3 participants