RST files scan

Author: luszczewskakasia1

.github/workflows/reusable_checks.yml

@@ -21,15 +21,15 @@ jobs:
     - name: Install dependencies
       run: |
         sudo apt-get update
-        sudo apt-get install -y black cmake clang-format-15 cmake-format libhwloc-dev
+        sudo apt-get install -y black cmake clang-format-15 cmake-format libhwloc-dev enchant-2 doxygen
 
     # Latest distros do not allow global pip installation
     - name: Install Python requirements in venv
       run: |
         python3 -m venv .venv
         . .venv/bin/activate
         echo "$PATH" >> $GITHUB_PATH
-        python3 -m pip install bandit codespell
+        python3 -m pip install bandit codespell breathe sphinxcontrib-spelling sphinx_book_theme
 
     - name: Configure CMake
       run: >
@@ -60,6 +60,12 @@ jobs:
     - name: Run codespell
       run: python3 ./.github/scripts/run-codespell.py
 
+    - name: Run RST files scan
+      run: |
+        cmake -B build
+        cmake --build build --target docs
+        sphinx-build -b spelling ./build/docs_build/config ./build/docs_build/spelling_log -W
+
     # Run Bandit recursively, but omit _deps directory (with 3rd party code) and python's venv
     - name: Run Bandit
       run: python3 -m bandit -r . -x '/_deps/,/.venv/'

docs/config/Doxyfile

@@ -445,7 +445,7 @@ INLINE_SIMPLE_STRUCTS  = NO
 # types are typedef'ed and only the typedef is referenced, never the tag name.
 # The default value is: NO.
 
-TYPEDEF_HIDES_STRUCT   = NO
+TYPEDEF_HIDES_STRUCT   = YES
 
 # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
 # cache is used to resolve symbols given their name and scope. Since this can be
@@ -935,7 +935,7 @@ EXCLUDE_PATTERNS       =
 # Note that the wildcards are matched against the file with absolute path, so to
 # exclude all test directories use the pattern */test/*
 
-EXCLUDE_SYMBOLS        =
+EXCLUDE_SYMBOLS        = 
 
 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
 # that contain example code fragments that are included (see the \include
@@ -2200,7 +2200,7 @@ INCLUDE_PATH           =
 # used.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-INCLUDE_FILE_PATTERNS  =
+INCLUDE_FILE_PATTERNS  = 
 
 # The PREDEFINED tag can be used to specify one or more macro names that are
 # defined before the preprocessor is started (similar to the -D option of e.g.

docs/config/conf.py

@@ -30,12 +30,16 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["breathe"]
+extensions = ["breathe", "sphinxcontrib.spelling"]
+
+spelling_show_suggestions = True
+spelling_word_list_filename = "exclude_words.txt"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+suppress_warnings = ["ref.any"]
 
 primary_domain = "c"
 

docs/config/exclude_words.txt

@@ -0,0 +1,77 @@
+allocator
+allocators
+Allocators
+oneTBB
+stdout
+pid
+customizable
+deallocations
+malloc
+jemalloc
+Jemalloc
+umfPoolRealloc
+umfPoolCalloc
+umfPoolMallocUsableSize
+daxX
+dev
+Memspace
+memspaces
+Mempolicy
+mempolicies
+Memtarget
+memtargets
+umfOsMemoryProviderParamsDestroy
+CXL
+oneAPI
+mem
+Globals
+umfMemoryProviderGetLastNativeError
+deallocating
+umfPoolDestroy
+umfPool
+umf
+hPool
+ptr
+calloc
+realloc
+hProvider
+umfPoolGetTag
+poolable
+unfreed
+tp
+deallocating
+addr
+ipc
+providerIpcData
+providential
+umfMemoryProviderAlloc
+preallocated
+providerIpcData
+umfMemoryProviderOpenIPCHandle
+lowPtr
+highPtr
+pre
+params
+linux
+nodemask
+Nodemask
+maxnode
+deallocation
+Devdax
+numa
+umfMemspaceUserFilter
+memspace
+hMemtarget
+umfMemspaceMemtargetAdd
+memtarget
+mempolicy
+partList
+umfGetIPCHandle
+interprocess
+Tiering
+tiering
+preallocated
+deallocation
+io
+multithreading
+middleware

third_party/requirements.txt

@@ -13,5 +13,6 @@ sphinxcontrib_htmlhelp==2.1.0
 sphinxcontrib_serializinghtml==2.0.0
 sphinxcontrib_qthelp==2.0.0
 breathe==4.35.0
+sphinxcontrib-spelling==8.0.0
 sphinx==8.1.3
 sphinx_book_theme==1.1.3