mirror of
https://github.com/odoo/documentation.git
synced 2025-12-12 07:29:27 +07:00
848cb0fff3
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#14716
X-original-commit: 41f2e20636
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Odoo documentation
Build the documentation locally
Requirements
- Git
- Python 3.6, 3.7, or 3.8
- Python dependencies listed in the file
requirements.txt. - Make
- A local copy of the odoo/odoo repository (optional)
- A local copy of the odoo/upgrade-util repository (optional)
Instructions
- In a terminal, navigate to the root directory of the documentation and build it
make. Additional commands are available withmake help. - Open the file
documentation/_build/html/index.htmlin your web browser. - See this guide for more detailed instructions.
Optional: place your local copy of the odoo/odoo and odoo/upgrade-util repositories in
the parent directory or in the root directory of the documentation to build the latter
with the documented Python docstrings.
Contribute to the documentation
For contributions to the content of the documentation, please refer to the Introduction Guide.
To report a content issue, request new content or ask a question, use the repository's issue tracker.
Learn More
To learn more about Odoo, in addition to the documentation, have a look at the official eLearning and Scale-up, The Business Game.