Run rstcheck in CI (#854)

home-assistant-libs · Feb 15, 2024 · 2d7ad05 · 2d7ad05
1 parent 0ea9c09
commit 2d7ad05
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -35,3 +35,6 @@ jobs:
       - name: Lint with pylint
         run: |
           pylint examples pychromecast
+      - name: Lint with rstcheck
+        run: |
+          rstcheck README.rst
diff --git a/pyproject.toml b/pyproject.toml
@@ -31,6 +31,11 @@ classifiers=[
 [tool.black]
 exclude = 'pb2'
 
+[tool.rstcheck]
+# README.rst has embedded python examples which show the interactive interpreter output
+# that's not valid Python, so we disable the check
+ignore_languages = ["python"]
+
 [tool.setuptools]
 platforms = ["any"]
 zip-safe  = false

diff --git a/requirements-test.txt b/requirements-test.txt
@@ -4,6 +4,7 @@ flake8==7.0.0
 mypy==1.8.0
 PlexAPI==4.15.9
 pylint==3.0.3
+rstcheck==6.2.0
 types-beautifulsoup4==4.12.0.20240106
 types-html5lib==1.1.11.20240106
 types-protobuf==4.24.0.20240129