diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 98ee83a90..d1a3d68ba 100644 --- 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 index 0f19c7114..e5c3415ca 100644 --- 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 index 420c4fc21..24574103a 100644 --- 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