81bf067ba1
Prior to this commit, the /legal.html page relied on RST substitutions to insert the images directives of legal agreements within the table. This caused Sphinx to omit the `image-reference` class on all `<a>` elements surrounding an `<img>` element, which it normally adds when the `target` option is specified on an `image` directive. As the theme relies on that class to hide the "external link" icon added with commit343decf1, the layout of the page was broken. While replacing the substitutions with the plain `image` directive, the grid table is converted to a list table to avoid the hassle of expanding table cells to fit the directives. This will also help in maintaining the content of the table when we will add new translations for the legal agreements. task-2909167 closes odoo/documentation#2461 X-original-commit:2bf2604Signed-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 in 14.0 (Optional)
Instructions
-
In a terminal, navigate to the root directory and compile the documentation to HTML with the following command:
makeAdditional commands are available with
make help. -
Open the file
documentation/_build/html/index.htmlin your web browser to display the render. -
See this guide for more detailed instructions.
Optional: to fully build the developer documentation with inline docstrings for documented Python
functions, place your local copy of the odoo/odoo repository in the root directory. Alternatively,
create a symbolic link with odoo as link name. If the Odoo sources are not found, a warning will
be shown.
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 as usual.
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.