WIP - RST check

.github/workflows/linting.yml

@@ -27,6 +27,25 @@ jobs:
         with:
           globs: "**/*.md"
 
+  lint-rst:
+    name: "reStructuredText"
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - name: Install rstcheck
+        run: |
+          python -m pip install --upgrade pip
+          pip install rstcheck
+      - name: Run rstcheck
+        run: |
+          rstcheck --config .rstcheck.cfg --log-level INFO --recursive docs
+
   spelling:
     name: "Spelling"
     runs-on: ubuntu-latest

.rstcheck.cfg

@@ -0,0 +1,51 @@
+[rstcheck]
+# Ignore Sphinx-specific roles that are not part of standard RST
+ignore_roles =
+    meth,
+    class,
+    ref,
+    doc,
+    attr,
+    mod,
+    func,
+    data,
+    const,
+    exc,
+    obj,
+    any,
+    py:class,
+    py:meth,
+    py:func,
+    py:mod,
+    py:attr,
+    py:exc,
+    py:obj,
+    py:data
+
+# Ignore Sphinx-specific directives
+ignore_directives =
+    automodule,
+    autoclass,
+    autofunction,
+    autodata,
+    toctree,
+    literalinclude,
+    code-block,
+    note,
+    warning,
+    versionadded,
+    versionchanged,
+    deprecated,
+    seealso,
+    rubric,
+    centered,
+    hlist,
+    glossary,
+    productionlist,
+    include
+
+# Ignore common informational messages
+ignore_messages = (Hyperlink target "[^"]*" is not referenced\.$)
+
+# Report level: ERROR, WARNING, INFO
+report_level = WARNING