Using sphinxcontrib.spelling as extension

oleksandr-pavlyk · oleksandr-pavlyk · commit ee22e70fb070 · 2024-04-17T08:38:58.000-05:00
diff --git a/.github/workflows/generate-docs.yml b/.github/workflows/generate-docs.yml
@@ -56,7 +56,7 @@ jobs:
         run: |
           pip install numpy cython setuptools scikit-build cmake sphinx"<7.2" pydot graphviz furo \
                       sphinxcontrib-programoutput sphinxcontrib-googleanalytics sphinx-design \
-                      sphinxcontrib-jsmath sphinx-copybutton
+                      sphinxcontrib-jsmath sphinx-copybutton sphinxcontrib-spelling
       - name: Checkout repo
         uses: actions/checkout@v4.1.1
         with:
diff --git a/docs/doc_sources/conf.py.in b/docs/doc_sources/conf.py.in
@@ -39,10 +39,12 @@ extensions = [
     "sphinx.ext.viewcode",
     "sphinxcontrib.programoutput",
     "sphinxcontrib.googleanalytics",
+    "sphinxcontrib.spelling",
     "sphinx_design",
 ]
 
 copybutton_prompt_text = ">>> "
+spelling_warning = True
 
 googleanalytics_id = 'G-7TCKS5BHYE'
 googleanalytics_enabled = True
diff --git a/docs/doc_sources/known_words.txt b/docs/doc_sources/known_words.txt
@@ -0,0 +1,42 @@
+amongst
+unpartitioned
+systemwide
+toolchain
+interoperate
+programmatically
+conda
+cmake
+scikit
+oneAPI
+oneMKL
+dpctl
+runtime
+DPC
+DPC++
+backend
+backends
+deleter
+allocator
+allocators
+deallocated
+USM
+dimensionality
+accessor
+doxygen
+const
+namespace
+DRef
+PRef
+QRef
+CRef
+KBRef
+KRef
+MRef
+Ptr
+Src
+Dst
+sycl
+nullptr
+opencl
+cuda
+enqueued
