Docs: Enable spell check

.cirrus.yml

@@ -17,12 +17,12 @@ container:
 
 env:
   # Skip specific tasks by name. Set to a non-empty string to skip.
-  SKIP_LINT_TASK: ""
-  SKIP_TEST_MINIMAL_TASK: ""
-  SKIP_TEST_FULL_TASK: ""
-  SKIP_GALLERY_TASK: ""
-  SKIP_DOCTEST_TASK: ""
-  SKIP_LINKCHECK_TASK: ""
+  SKIP_LINT_TASK: "Yup"
+  SKIP_TEST_MINIMAL_TASK: "Yup"
+  SKIP_TEST_FULL_TASK: "Yup"
+  SKIP_GALLERY_TASK: "Yup"
+  SKIP_DOCTEST_TASK: "Yup"
+  SKIP_DOCCHECK_TASK: ""
   # Skip task groups by type. Set to a non-empty string to skip.
   SKIP_ALL_TEST_TASKS: ""
   SKIP_ALL_DOC_TASKS: ""
@@ -185,6 +185,10 @@ gallery_task:
   env:
     PY_VER: 3.8
   name: "${CIRRUS_OS}: py${PY_VER} doc tests (gallery)"
+  container:
+    dockerfile: requirements/ci/Dockerfile
+    cpu: 2
+    memory: 4G
   << : *IRIS_TEST_DATA_TEMPLATE
   << : *LINUX_TASK_TEMPLATE
   tests_script:
@@ -206,6 +210,10 @@ doctest_task:
     MPL_RC_DIR: ${HOME}/.config/matplotlib
     MPL_RC_FILE: ${HOME}/.config/matplotlib/matplotlibrc
   name: "${CIRRUS_OS}: py${PY_VER} doc tests"
+  container:
+    dockerfile: requirements/ci/Dockerfile
+    cpu: 2
+    memory: 4G
   << : *IRIS_TEST_DATA_TEMPLATE
   << : *LINUX_TASK_TEMPLATE
   tests_script:
@@ -220,20 +228,24 @@ doctest_task:
 
 
 #
-# Testing Documentation Link Check (Linux)
+# Checking documentating.  Includes linkcheck and spelling (Linux)
 #
-linkcheck_task:
-  only_if: ${SKIP_LINKCHECK_TASK} == "" && ${SKIP_ALL_DOC_TASKS} == ""
+doccheck_task:
+  only_if: ${SKIP_DOCCHECK_TASK} == "" && ${SKIP_ALL_DOC_TASKS} == ""
   << : *CREDITS_TEMPLATE
   env:
     PY_VER: 3.8
     MPL_RC_DIR: ${HOME}/.config/matplotlib
     MPL_RC_FILE: ${HOME}/.config/matplotlib/matplotlibrc
-  name: "${CIRRUS_OS}: py${PY_VER} doc link check"
+  name: "${CIRRUS_OS}: py${PY_VER} doc check"
+  container:
+    dockerfile: requirements/ci/Dockerfile
+    cpu: 2
+    memory: 4G
   << : *LINUX_TASK_TEMPLATE
   tests_script:
     - export CONDA_OVERRIDE_LINUX="$(uname -r | cut -d'+' -f1)"
     - mkdir -p ${MPL_RC_DIR}
     - echo "backend : agg" > ${MPL_RC_FILE}
     - echo "image.cmap : viridis" >> ${MPL_RC_FILE}
-    - nox --session linkcheck -- --verbose
+    - nox --session doccheck -- --verbose

docs/src/Makefile

@@ -52,7 +52,7 @@ html-noplot:
 	@echo "Build finished. The HTML (no gallery) pages are in $(BUILDDIR)/html"
 
 spelling:
-	$(SPHINXBUILD) -b spelling $(SRCDIR) $(BUILDDIR)
+	$(SPHINXBUILD) -b spelling $(WARNING_TO_ERROR) $(SRCDIR) $(BUILDDIR)
 	@echo
 	@echo "Build finished. The HTML (no gallery) pages are in $(BUILDDIR)/html"
 

docs/src/conf.py

@@ -151,8 +151,7 @@ def _dotv(version):
     "sphinx_copybutton",
     "sphinx.ext.napoleon",
     "sphinx_panels",
-    # TODO: Spelling extension disabled until the dependencies can be included
-    # "sphinxcontrib.spelling",
+    "sphinxcontrib.spelling",
     "sphinx_gallery.gen_gallery",
     "matplotlib.sphinxext.mathmpl",
     "matplotlib.sphinxext.plot_directive",
@@ -183,6 +182,7 @@ def _dotv(version):
 # -- spellingextension --------------------------------------------------------
 # See https://sphinxcontrib-spelling.readthedocs.io/en/latest/customize.html
 spelling_lang = "en_GB"
+tokenizer_lang = "en_GB"
 # The lines in this file must only use line feeds (no carriage returns).
 spelling_word_list_filename = ["spelling_allow.txt"]
 spelling_show_suggestions = False

docs/src/developers_guide/contributing_ci_tests.rst

@@ -75,7 +75,7 @@ the PR is merged, to prevent overwriting developer commits.
 The auto-updater can still be invoked manually in this situation by going to the `GitHub Actions`_
 page for the workflow, and manually running using the "Run Workflow" button.  
 By default, this will also not override developer commits.  To force an update, you must 
-confirm "yes" in the "Run Worflow" prompt.
+confirm "yes" in the "Run Workflow" prompt.
 
 
 .. _skipping Cirrus-CI tasks:

docs/src/developers_guide/contributing_documentation.rst

@@ -51,7 +51,8 @@ This is useful for a final test before committing your changes.
 
 .. note:: In order to preserve a clean build for the html, all **warnings**
           have been promoted to be **errors** to ensure they are addressed.
-          This **only** applies when ``make html`` is run.
+          This **only** applies when ``make html`` and ``make spelling`` is
+          run.
 
 .. _cirrus-ci: https://cirrus-ci.com/github/SciTools/iris
 
@@ -90,16 +91,15 @@ adding it to the ``linkcheck_ignore`` array that is defined in the
 If this fails check the output for the text **broken** and then correct
 or ignore the url.
 
-.. comment
-    Finally, the spelling in the documentation can be checked automatically via the
-    command::
+Finally, the spelling in the documentation can be checked automatically via the
+command::
 
-        make spelling
+    make spelling
 
-    The spelling check may pull up many technical abbreviations and acronyms.  This
-    can be managed by using an **allow** list in the form of a file.  This file,
-    or list of files is set in the `conf.py`_ using the string list
-    ``spelling_word_list_filename``.
+The spelling check may pull up many technical abbreviations and acronyms.  This
+can be managed by using an **allow** list in the form of a file.  This file,
+or list of files is set in the `conf.py`_ using the string list
+``spelling_word_list_filename``.
 
 
 .. note:: In addition to the automated `cirrus-ci`_ build of all the

docs/src/developers_guide/contributing_getting_involved.rst

@@ -31,7 +31,7 @@ If you are new to using GitHub we recommend reading the
 .. note:: For more information on becoming a contributor_ including a link to
           the Contributors Licence Agreement (CLA) see the
           `Governance <https://scitools.org.uk/organisation.html#governance>`_
-          section of the `SciTools`_ ogranization web site.
+          section of the `SciTools`_ organisation web site.
 
 
 .. _GitHub getting started: https://docs.github.com/en/github/getting-started-with-github

docs/src/developers_guide/contributing_graphics_tests.rst

@@ -22,7 +22,7 @@ Challenges
 ==========
 
 Iris uses many dependencies that provide functionality, an example that
-applies here is matplotlib_.  For more information on the dependences, see
+applies here is matplotlib_.  For more information on the dependencies, see
 :ref:`installing_iris`.  When there are updates to the matplotlib_ or a
 dependency of matplotlib, this may result in a change in the rendered graphical
 output.  This means that there may be no changes to Iris_, but due to an