Commit Graph

12 Commits

Author SHA1 Message Date
Antoine Vandevenne (anv)
38c86f60d6 [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>
2025-09-30 16:48:33 +00:00
Antoine Vandevenne (anv)
a891fd9975 [FIX] tests: don't count EOL chars when checking remaining line space
This commit fixes a bug in the `check_early_line_breaks` test that would
systematically consider the `\n` character as being part of the line,
hence counting it when computing the line length.

closes odoo/documentation#12272

X-original-commit: e1a8a55c4f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2025-03-05 19:08:45 +00:00
Antoine Vandevenne (anv)
71d93c7db2 [FIX] tests: don't confuse separators for heading delimiters
RST separators (`-----`) look similar to H3 delimiters that use the same
`-` character, but separators' length should not be checked.

X-original-commit: a54a68823f
Part-of: odoo/documentation#12272
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2025-03-05 19:08:45 +00:00
samueljlieber
9b8723e544 [IMP] tests: check resource file referenced
X-original-commit: 3f1f02200b
Part-of: odoo/documentation#12082
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
2025-02-14 21:59:09 +00:00
Xavier-Do
d11dcd33d1 [IMP] adapt documentation for new install script
closes odoo/documentation#9559

X-original-commit: f1bd4ec134
Related: odoo/odoo#167454
Signed-off-by: Xavier Dollé (xdo) <xdo@odoo.com>
2024-06-01 16:32:16 +00:00
Sam Lieber (sali)
09e0b8affc [IMP] tests: make review UX and resource files
closes odoo/documentation#6434

X-original-commit: 25e204adcd
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Samuel Lieber (sali) <sali@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-11-14 02:35:55 +00:00
Victor Feyens
b9c7cd2ee8 [ADD] tests: image compression and resource file name checkers
task-2801043

closes odoo/documentation#4870

closes odoo/documentation#5436

X-original-commit: fa90e27c4e
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-08-10 10:39:09 +02:00
Sam Lieber (sali)
e70cec1c05 [IMP] test/rst_style, Makefile: add optional review checkers
task-2801043

closes odoo/documentation#5358

X-original-commit: 8eec0e7634
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-08-09 03:08:11 +02:00
Victor Feyens
b5140e2d22 [ADD] tests: image size checker
closes odoo/documentation#4100

X-original-commit: 380a5499de
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-11 15:17:26 +02:00
Antoine Vandevenne (anv)
7b9abb3bef [REF] tests: split checkers
task-2801043

closes odoo/documentation#3796

X-original-commit: 8e8c466892
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-03-10 11:24:06 +01:00
Victor Feyens
5f60c80baa [IMP] rst_style: new linters
X-original-commit: a33db1cbbb
Part-of: odoo/documentation#3796
2023-03-10 11:24:06 +01:00
Victor Feyens
080835be2b [ADD] tests: add sphinxlint checkers for headings
task-2801043

X-original-commit: ad768c33aa
Part-of: odoo/documentation#3553
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-13 14:05:35 +01:00