Skip to content

Commit 2d7ad05

Browse files
authored
Run rstcheck in CI (#854)
1 parent 0ea9c09 commit 2d7ad05

3 files changed

Lines changed: 9 additions & 0 deletions

File tree

.github/workflows/test.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,6 @@ jobs:
3535
- name: Lint with pylint
3636
run: |
3737
pylint examples pychromecast
38+
- name: Lint with rstcheck
39+
run: |
40+
rstcheck README.rst

pyproject.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@ classifiers=[
3131
[tool.black]
3232
exclude = 'pb2'
3333

34+
[tool.rstcheck]
35+
# README.rst has embedded python examples which show the interactive interpreter output
36+
# that's not valid Python, so we disable the check
37+
ignore_languages = ["python"]
38+
3439
[tool.setuptools]
3540
platforms = ["any"]
3641
zip-safe = false

requirements-test.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ flake8==7.0.0
44
mypy==1.8.0
55
PlexAPI==4.15.9
66
pylint==3.0.3
7+
rstcheck==6.2.0
78
types-beautifulsoup4==4.12.0.20240106
89
types-html5lib==1.1.11.20240106
910
types-protobuf==4.24.0.20240129

0 commit comments

Comments
 (0)