Merge pull request bytecodealliance#232 from midokura/ape/add-rst-checker

Add documentation formatting check

Author: jordi-midokura

.github/workflows/check.yml

@@ -29,5 +29,14 @@ jobs:
           repository: midokura/wedge-agent-oss-playground
           ref: ${{ inputs.ref }}
 
+      - name: Prepare venv
+        run: |
+          python3 -m venv .venv
+          . .venv/bin/activate && \
+            pip install -r docs/requirements.txt
+
       - name: Check formatting
-        run: make check
+        run: |
+          . .venv/bin/activate && \
+            make -f check.mk check check-docs -j
+

check.mk

@@ -72,3 +72,8 @@ check-shell:
 	@echo Checking shell script formatting
 	@git ls-files '*.sh' | xargs $(BASHATE) -iE006 -eE005,E042,E043
 .PHONY: check-shell
+
+check-docs:
+	@echo Checking docs files
+	@rstcheck docs/**/*.rst
+.PHONY: check-docs

docs/requirements.txt

@@ -5,3 +5,4 @@
 sphinx==7.1.2
 sphinx-rtd-theme==1.3.0rc1
 myst_parser==3.0.0
+rstcheck==6.2.4

pyproject.toml

@@ -9,3 +9,17 @@ build-backend = "flit_core.buildapi"
 [project]
 name = "Wedge Agent"
 dynamic = ["version", "description"]
+
+[tool.rstcheck]
+report_level = "WARNING"
+#ignore_directives = []
+#ignore_roles = []
+#ignore_substitutions = []
+ignore_languages = [
+    "python",
+    "cpp",
+    "c",
+    "shell",
+    "json"
+]
+ignore_messages = "(Hyperlink target \".*\" is not referenced.$)"