1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
"""
Test the README file.
This is necessary because a deployment does not work if the README file
has errors.
Credits: https://stackoverflow.com/a/47494076/1320237
"""
from pathlib import Path
import restructuredtext_lint
HERE = Path(__file__).parent
readme_path = Path(HERE).parent / "README.rst"
def test_readme_file():
"""CHeck README file for errors."""
messages = restructuredtext_lint.lint_file(str(readme_path))
error_message = "expected to have no messages about the README file!"
for message in messages:
print(message.astext())
error_message += "\n" + message.astext()
assert len(messages) == 0, error_message
|
