I have a number of reusable GitHub CI wokflows. One of them creates python environments of different versions and runs checks and tests.
The doc8 command is common for any environment: doc8 --config pyproject.toml ./docs
Here you can see 3 different jobs with 3.9, 3.10 and 3.11 (in the middle) environments:
All the jobs, except 3.11 passed.
Pyproject.toml has the following simple setting:
[tool.doc8] # RST linter
# https://github.com/PyCQA/doc8
max-line-length = 99
The length of each string is lower than 99.
I tried run doc8 locally on Python 3.11.4 by doc8 --config pyproject.toml ./docs and it also failed:
(py3.11) serge@dell:~/my_prj$ doc8 --config pyproject.toml docs/
Scanning...
Validating...
docs/index.rst:4: D001 Line too long
docs/index.rst:6: D001 Line too long
docs/index.rst:13: D001 Line too long
docs/index.rst:16: D001 Line too long
docs/index.rst:18: D001 Line too long
========
Total files scanned = 9
Total files ignored = 0
Total accumulated errors = 5
Detailed error counts:
- doc8.checks.CheckCarriageReturn = 0
- doc8.checks.CheckIndentationNoTab = 0
- doc8.checks.CheckMaxLineLength = 5
- doc8.checks.CheckNewlineEndOfFile = 0
- doc8.checks.CheckTrailingWhitespace = 0
- doc8.checks.CheckValidity = 0
I have a number of reusable GitHub CI wokflows. One of them creates python environments of different versions and runs checks and tests.
The doc8 command is common for any environment:
doc8 --config pyproject.toml ./docsHere you can see 3 different jobs with 3.9, 3.10 and 3.11 (in the middle) environments:
All the jobs, except 3.11 passed.
Pyproject.toml has the following simple setting:
The length of each string is lower than 99.
I tried run doc8 locally on Python 3.11.4 by
doc8 --config pyproject.toml ./docsand it also failed: