summaryrefslogtreecommitdiff
path: root/doc/check_rst_files.py
diff options
context:
space:
mode:
Diffstat (limited to 'doc/check_rst_files.py')
-rw-r--r--doc/check_rst_files.py24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/check_rst_files.py b/doc/check_rst_files.py
new file mode 100644
index 000000000..71ac3e0b2
--- /dev/null
+++ b/doc/check_rst_files.py
@@ -0,0 +1,24 @@
+import glob
+import os
+
+import restructuredtext_lint
+
+os.chdir('..')
+issues = []
+
+print('==Linting reStructuredText files with rst-lint==')
+
+for file in glob.iglob('**/*.rst', recursive=True):
+ issues.extend(restructuredtext_lint.lint_file(filepath=file))
+
+
+if issues:
+ for issue in issues:
+ print('{type}:{filename}:{line} {message}'.format(
+ type=issue.type,
+ filename=issue.source,
+ line=issue.line,
+ message=issue.message.replace('\n', ' ')))
+ print('reStructuredText linter found {} issues in rst files!'.format(
+ len(issues)))
+ exit(1)