build: add check-rst target to lint rst

Add a target to lint the rst files that are not part of documentation under doc/ or tests under test/ to catch errors before pushing.
jnikula · Oct 4, 2023 · 6d9f0a9 · 6d9f0a9
1 parent cd9f3af
commit 6d9f0a9
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 0 deletions.
diff --git a/Makefile.local b/Makefile.local
@@ -15,6 +15,8 @@
 
 dir := .
 
+RST := $(RST) CHANGELOG.rst CONTRIBUTING.rst README.rst
+
 FLAKE8_IGNORE=\
 	E302,\
 	E305,\
@@ -25,6 +27,10 @@ FLAKE8_IGNORE=\
 check:
 	flake8 --extend-ignore="$(FLAKE8_IGNORE)" --max-line-length=100 src/hawkmoth test
 
+.PHONY: check-rst
+check-rst:
+	rst-lint --level warning $(RST)
+
 # assume virtual environment is used for dist and upload
 .PHONY: build-tools
 build-tools:

diff --git a/requirements.txt b/requirements.txt
@@ -2,5 +2,6 @@ flake8
 pytest
 pytest-cov
 pytest-xdist
+restructuredtext_lint
 sphinx
 strictyaml
diff --git a/setup.cfg b/setup.cfg
@@ -48,6 +48,7 @@ dev =
     pytest
     pytest-cov
     pytest-xdist
+    restructuredtext_lint
     strictyaml
 
 [options.package_data]

diff --git a/test/Makefile.local b/test/Makefile.local
@@ -4,6 +4,8 @@
 
 test_dir := test
 
+RST := $(RST) $(test_dir)/README.rst
+
 .PHONY: test
 test:
 	pytest -n auto $(test_dir)