Enabling spellcheck: sphinxcontrib-spelling as an extension for Sphinx

.github/workflows/test.yml

@@ -15,6 +15,7 @@ jobs:
       - name: "Install requirements"
         run: |
           pip install -r requirements.txt
+          sudo apt-get install -y hunspell-en-ca hyphen-en-ca
       - name: "Run build test"
         run: |
           make test

Makefile

@@ -177,9 +177,15 @@ pseudoxml:
 	@echo
 	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
 
+spelling:
+	$(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling
+	@echo
+	@echo "Build finished. The spelling files are in $(BUILDDIR)/spelling."
+
 dos2unix:
 	find . -name "*.txt" | grep -v _build | xargs -IF fromdos F
 
 .PHONY: test
 test:
 	$(MAKE) html ALLSPHINXOPTS="-W --keep-going -n ."
+	$(MAKE) spelling ALLSPHINXOPTS="-W --keep-going ."

conf.py

@@ -42,8 +42,18 @@
     "sphinx.ext.extlinks",
     "sphinx.ext.intersphinx",
     "sphinx_version_ref",
+    "sphinxcontrib.spelling",
 ]
 
+# spelling
+
+spelling_lang="en_CA"
+tokenizer_lang="en_CA"
+
+spelling_word_list_filename = ['spelling_wordlist.txt']
+
+spelling_show_suggestions=True
+
 # Obtain intersphinx_mapping
 inventory = "https://gist.githubusercontent.com/qubot/2dd2f7f96e51121061d4/raw/sphinxdoc-inventory.json"
 response = urlopen(inventory)

requirements.txt

@@ -1,3 +1,4 @@
 sphinx
 sphinx_rtd_theme
-sphinx_version_ref
+sphinx_version_ref
+sphinxcontrib-spelling