setting up spellchecking as a test in github

.github/workflows/test.yml

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

Makefile

@@ -224,6 +224,11 @@ dummy:
 	@echo
 	@echo "Build finished. Dummy builder generates no files."
 
+spelling:
+	$(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling
+	@echo
+	@echo "Build finished. The spelling files are in $(BUILDDIR)/spelling."
+
 .PHONY: test
 test:
 	$(MAKE) html ALLSPHINXOPTS="-W --keep-going -n ."

conf.py

@@ -36,8 +36,18 @@
 extensions = [
     'sphinx.ext.extlinks',
     'sphinx.ext.intersphinx',
+     'sphinxcontrib.spelling',
 ]
 
+# Spellchecking
+
+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 +1,2 @@
 sphinx==7.4.7
+sphinxcontrib-spelling