Add sphinxcontrib-spelling to Sphinx config and CI, spelling-wordlist

.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:

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/*']

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