From 20fc9cee666d5e83aa065ba7c808ae70c4318957 Mon Sep 17 00:00:00 2001
From: Markus Heikkinen <markus.heikkinen@zhinst.com>
Date: Mon, 20 Jun 2022 12:22:54 +0200
Subject: [PATCH] Add sphinxcontrib-spelling to Sphinx config and CI,
 spelling-wordlist

---
 .github/workflows/docs.yml        |  4 ++
 docs/source/conf.py               |  7 +++
 docs/source/spelling_wordlist.txt | 99 +++++++++++++++++++++++++++++++
 3 files changed, 110 insertions(+)
 create mode 100644 docs/source/spelling_wordlist.txt

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 06a4185d..c20799bf 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -37,6 +37,10 @@ jobs:
           sudo dpkg -i pandoc-2.18-1-amd64.deb
           cd docs && make html EXAMPLE_SRC=remote
 
+      - name: "Test spelling docs"
+        run: |
+          cd docs && sphinx-build -b spelling -q source build/spelling
+
       - name: Store artifacts
         uses: actions/upload-artifact@v2
         with:
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 18622f3c..9c2a691e 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -100,3 +100,10 @@
 
 nbsphinx_codecell_lexer = "none"
 highlight_language = "none"
+
+# Spelling
+# sphinxcontrib.spelling configuration file
+spelling_word_list_filename='spelling_wordlist.txt'
+# Show suggestion in console output
+spelling_show_suggestions=False
+spelling_exclude_patterns=['examples/*']
diff --git a/docs/source/spelling_wordlist.txt b/docs/source/spelling_wordlist.txt
new file mode 100644
index 00000000..fe36e6cb
--- /dev/null
+++ b/docs/source/spelling_wordlist.txt
@@ -0,0 +1,99 @@
+zhinst
+pythonic
+namespace
+Jupyter
+Bugfix
+qccs
+Changelog
+json_schema
+json
+sw
+Quickstart
+Natively
+preinitialized
+preloaded
+unmanaged
+autocompletion
+
+uhfqa
+shfqa
+uhfli
+shfsg
+hdawg
+sgchannels
+qachannels
+awg
+awgs
+ZSync
+zsync
+shfqc
+pqsc
+daq
+docstring
+qa
+qas
+qcodes
+deviceutils
+ziPython
+streamingnodes
+nodetree
+dev
+ziDAQServer
+excludevectors
+excludestreaming
+basechannelonly
+subscribedonly
+streamingonly
+settingsonly
+unsubscription
+leavesonly
+utils
+SHFSweeper
+commandtable
+Enums
+getDouble
+getInt
+getString
+listNodesJSON
+getString
+setVector
+args
+kwargs
+functools
+iter
+len
+bool
+autoattribute
+nodelike
+mds
+precompensation
+precompensationAdvisor
+Labber
+playWave
+Xilinx
+
+ns
+holdoff
+dBm
+qubits
+qubit
+qutrits
+ququads
+num
+LF
+rf
+lf
+deskew
+clk
+pid
+bitwise
+GbE
+localhost
+uint
+Vpp
+Autoranging
+autorange
+Loopback
+gaussian
+upconversion
+clockbase
\ No newline at end of file