[IMP] test/rst_style, Makefile: add optional review checkers

task-2801043

closes odoo/documentation#5355

X-original-commit: 8eec0e7634
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit is contained in:
Sam Lieber (sali)
2023-08-04 19:29:37 +00:00
committed by Antoine Vandevenne (anv)
parent dcb0b5d463
commit 4f3730be43
3 changed files with 57 additions and 7 deletions
+6 -7
View File
@@ -23,9 +23,7 @@ def run_additional_checks(argv=None):
"""
The following checkers are selected.
Base checkers:
The following checkers are selected for `make test`.
- backtick-before-role: Search for roles preceded by a backtick.
- bad-dedent: Check for mis-alignment in indentation in code blocks.
- carriage-return: Check for carriage returns (\r) in lines.
@@ -49,12 +47,13 @@ Base checkers:
- role-without-backticks: Search roles without backticks.
- trailing-whitespace: Check for trailing whitespaces at end of lines.
- unbalanced-inline-literals-delimiters: Search for unbalanced inline literals delimiters.
---
- all the checkers defined in checkers/* files.
Optional checkers:
- line-too-long: Check for line length; this checker is not run by default.
The following checkers are only selected for `make review`.
- line-too-long: Check for line length.
- early-line-break: Check for early line breaks.
Custom checkers:
- all the checkers defined in checkers/* files
"""
if __name__ == '__main__':
# Patch sphinxlint's global constants to include our custom directives and parse their content.