Spell check (#1052)

* simple refactor

* utilize the spellcheck sphinx plugin

.github/workflows/publish.yml

@@ -24,6 +24,10 @@ jobs:
           ruby-version: '3.3'
           bundler-cache: true
 
+      - name: Check Spelling
+        run: |
+          rake spellcheck || true
+
       - name: Make Html
         run: |
           rake build

Makefile

@@ -223,3 +223,9 @@ dummy:
 	$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
 	@echo
 	@echo "Build finished. Dummy builder generates no files."
+
+.PHONY: spellcheck
+spellcheck:
+	$(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

Rakefile

@@ -5,13 +5,12 @@ end
 
 desc "Build docs using docker"
 task :build do
-  if podman?
-    exec "podman run --rm -it -v #{__dir__}:/doc #{image} make html"
-  elsif docker?
-    exec "docker run --rm -it -v '#{__dir__}:/doc' -u '#{user_group}' #{image} make html"
-  else
-    raise StandardError, "Cannot find any suitable container runtime to build. Need 'podman' or 'docker' installed."
-  end
+  exec "#{run_cmd} make html"
+end
+
+desc "Spellcheck"
+task :spellcheck do
+  exec "#{run_cmd} make spellcheck"
 end
 
 desc "Open built documentation in browser"
@@ -25,7 +24,7 @@ def user_group
 end
 
 def image
-  'ohiosupercomputer/ood-doc-build:v3.0.0'
+  'ohiosupercomputer/ood-doc-build:v3.1.0'
 end
 
 def docker?
@@ -37,3 +36,13 @@ def podman?
   `which podman 2>/dev/null 2>&1`
   $?.success?
 end
+
+def run_cmd
+  if podman?
+    "podman run --rm -it -v #{__dir__}:/doc #{image}"
+  elsif docker?
+    "docker run --rm -it -v '#{__dir__}:/doc' -u '#{user_group}' #{image}"
+  else
+    raise StandardError, "Cannot find any suitable container runtime to build. Need 'podman' or 'docker' installed."
+  end
+end

source/conf.py

@@ -38,7 +38,8 @@
     'sphinx.ext.githubpages',
     'sphinxcontrib.httpdomain',
     'sphinxcontrib.plantuml',
-    'sphinx_tabs.tabs'
+    'sphinx_tabs.tabs',
+    'sphinxcontrib.spelling'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -411,3 +412,6 @@ def setup(app):
 doc_context = {
     'ondemand_version':              version,
 }
+
+# spelling configurations
+spelling_ignore_contributor_names = False

source/spelling_wordlist.txt

@@ -0,0 +1,7 @@
+backport
+backporting
+websocket
+Phusion
+Stata
+VNC
+Fluxbox