Implement spellcheck

Author: Tom-Willemsen

.github/workflows/documentation.yml

@@ -3,6 +3,17 @@ name: sphinx
 on: [push, pull_request, workflow_call]
 
 jobs:
+  spellcheck:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: install requirements
+        run: pip install -e .[dev]
+      - name: run spellcheck
+        run: sphinx-build -b spelling doc _build
   call_sphinx_builder:
     uses: ISISComputingGroup/reusable-workflows/.github/workflows/sphinx.yml@main
     secrets: inherit

.gitignore

@@ -3,3 +3,4 @@
 ibex_developers_manual.egg-info/
 build/
 _build/
+doc/words.txt

doc/conf.py

@@ -6,8 +6,6 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-import os
-import sys
 
 project = "IBEX Developer's Manual"
 copyright = ""
@@ -20,10 +18,10 @@
 nitpicky = True
 
 myst_enable_extensions = [
-    "dollarmath", 
-    "strikethrough", 
-    "colon_fence", 
-    "linkify", 
+    "dollarmath",
+    "strikethrough",
+    "colon_fence",
+    "linkify",
     "html_image",
     "attrs_block",
 ]
@@ -69,10 +67,14 @@
 html_favicon = "favicon.ico"
 html_static_path = ["_static"]
 html_css_files = [
-    'css/custom.css',
+    "css/custom.css",
 ]
 
 autoclass_content = "both"
 myst_heading_anchors = 7
 html_last_updated_fmt = ""
 html_show_copyright = False
+
+spelling_lang = "en_GB"
+spelling_filters = ["enchant.tokenize.MentionFilter"]
+spelling_exclude_patterns = ["Glossary.md"]

doc/specific_iocs/choppers/FZJ_DD_Fermi_chopper.md

@@ -7,7 +7,7 @@ Prototype digital drive Fermi chopper controller made by Forschungszentrum Jüli
 ## Gotchas
 - Only one TCP connection allowed at a time. Other TCP connections will appear to connect but not give any responses (this can cause the IOC to read "zero" for everything).
 - Message length limit at 19 chars. For some commands (e.g. setting phase setpoint) this means the device cannot handle more than 1 d.p. If the message is too long the device will respond with an error message and not accept the setpoint at all. This length limit *includes* the `\r\n` terminator so really the message length limit is 17 characters.
-- The manual does not match the command set. For example, the order of responses in the long response packet is incorrect and several of the commands simply don't exist. The best (most up-to-date) place to get the command syntax from is the Julich VIs which are running on the chopper control machine (David has a copy of these).
+- The manual does not match the command set. For example, the order of responses in the long response packet is incorrect and several of the commands simply don't exist. The best (most up-to-date) place to get the command syntax from is the Jülich VIs which are running on the chopper control machine (David has a copy of these).
 - Be careful about renaming/removing PVs, this IOC is used by a CaLAB wrapper and that will need to be updated if the PV names change.
 - Errors on all PVs are propagated from a single source so may not accurately reflect which command(s) have gone wrong