add job

configure job for docuemntation checking

Author: mdabrowski1990

.github/workflows/testing.yml

@@ -178,7 +178,7 @@ jobs:
           python -m pip install --upgrade setuptools
           pip install -r requirements.txt
 
-      - name: Install external packages used for dynamic tests
+      - name: Install external packages used for sorting imports
         run: |
           pip install .[sorting-imports]
 
@@ -187,3 +187,28 @@ jobs:
           isort uds
           isort tests
           isort examples
+
+  documentation_checks:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.12
+
+      - name: Install project dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install --upgrade setuptools
+          pip install -r requirements.txt
+
+      - name: Install external packages used for documentation checking
+        run: |
+          pip install .[docs-checks]
+
+      - name: Check RST documentation [doc8]
+        run: |
+          docs8 docs/source

pyproject.toml

@@ -66,12 +66,6 @@ test = [
     "pytest-cov",
     "pytest-asyncio",
 ]
-docs = [
-    "sphinx",
-    "sphinx-autoapi",
-    "sphinx-rtd-theme",
-    "tomli",
-]
 static-code-analysis = [
     "prospector == 1.10.3",
     "mypy == 1.9.0",
@@ -86,6 +80,15 @@ dependency-scan = [
 sorting-imports = [
     "isort == 5.13.2"
 ]
+docs = [
+    "sphinx",
+    "sphinx-autoapi",
+    "sphinx-rtd-theme",
+    "tomli",
+]
+docs-checks = [
+    "doc8 == 1.1.1",
+]
 
 
 [build-system]