From bd38480d9fdc556472852c07d6a2dd0d3fa3bfac Mon Sep 17 00:00:00 2001
From: Olaf Meeuwissen <paddy-hack@member.fsf.org>
Date: Thu, 13 Feb 2020 21:19:34 +0900
Subject: [PATCH] Add spell checking support

---
 .gitlab-ci.yml   | 2 ++
 conf.py          | 4 ++++
 requirements.txt | 1 +
 3 files changed, 7 insertions(+)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index d0f0c7c..443facc 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -9,6 +9,7 @@ test:
   before_script:
     - apt-get update  -qq
     - apt-get install -qqy --no-install-recommends
+              python3-enchant
               python3-setuptools
               python3-wheel
     - pip3 --quiet install -r requirements.txt
@@ -17,6 +18,7 @@ test:
     # sphinx-build invocations.
     - unset CI
     - sphinx-build -M linkcheck . _build/
+    - sphinx-build -M spelling . _build/ -W --keep-going
 
 pages:
   stage: publish
diff --git a/conf.py b/conf.py
index 97f1e78..7caad1e 100644
--- a/conf.py
+++ b/conf.py
@@ -29,6 +29,7 @@ release = version
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'sphinxcontrib.spelling'
 ]
 
 # Unconditional addition breaks 'sphinx-build'.  Versioning support is
@@ -57,6 +58,9 @@ today_fmt = '2008-05-03'
 
 highlight_language = 'c'
 
+spelling_lang = 'en-US'
+spelling_word_list_filename = 'wordlist.txt'
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
diff --git a/requirements.txt b/requirements.txt
index cadec80..ce5978e 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,2 +1,3 @@
 sphinx_rtd_theme
 sphinx-versions
+sphinxcontrib-spelling