[IMP] tests: enable additional resource file-related checkers

The following custom checkers were never run by the
`ci/documentation_guidelines` build and had to be run locally with
`make review`:
- `check_image_size`: Check that images are not larger than the maximum
  file size allowed for their extension.
- `check_image_color_depth`: Check that PNG images are compressed to
  8-bit color depth with PNGQuant.
- `check_resource_file_name`: Check that resource file names use hyphens
   rather than underscores.

Since reviewers systematically perform these checks manually, it makes
sense to include them in the standard test suite. Should a check raise
a false positive (e.g., an `example_db.zip` resource file is added and
hyphens should not be used), the red CI can be safely ignored as it is
not required for merging.

closes odoo/documentation#14713

X-original-commit: 41f2e20636
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>

tests/main.py

@@ -18,20 +18,23 @@ CUSTOM_RST_DIRECTIVES = [
 ]
 
 ADDITIONAL_CHECKERS = [
-    checkers.resource_files.check_resource_file_referenced
+    checkers.resource_files.check_image_size,
+    checkers.resource_files.check_image_color_depth,
+    checkers.resource_files.check_resource_file_name,
+    checkers.resource_files.check_resource_file_referenced,
 ]
 
 
 def run_additional_checks(argv=None):
     _enabled_checkers, args = sphinxlint.parse_args(argv)
     for path in chain.from_iterable(sphinxlint.walk(path, args.ignore) for path in args.paths):
-        if path.startswith('content') and not path.endswith('.rst'):
+        if 'content/' in path and not path.endswith('.rst'):  # Leave root and locale files alone.
             for checker in ADDITIONAL_CHECKERS:
                 checker(path)
 
 
 """
-The following checkers are selected for `make test`.
+The following built-in checkers are enabled 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.
@@ -55,13 +58,11 @@ The following checkers are selected for `make test`.
 - 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.
 
-The following checkers are only selected for `make review`.
-- line-too-long: Check for line length.
+All the custom checkers defined in checkers/* files are also enabled, except for the following ones,
+which are only enabled for `make review`:
+- line-too-long: Check for line lengths.
 - early-line-break: Check for early line breaks.
-
 """
 if __name__ == '__main__':
     # Patch sphinxlint's global constants to include our custom directives and parse their content.
@@ -87,10 +88,5 @@ if __name__ == '__main__':
         if os.getenv('REVIEW') == '1':  # Enable checkers for `make review`.
             setattr(sphinxlint.check_line_too_long, 'enabled', True)
             setattr(checkers.rst_style.check_early_line_breaks, 'enabled', True)
-            ADDITIONAL_CHECKERS.extend([
-                checkers.resource_files.check_image_size,
-                checkers.resource_files.check_image_color_depth,
-                checkers.resource_files.check_resource_file_name,
-            ])
         run_additional_checks()
         sys.exit(sphinxlint.main())