Odoo documentation sources
Go to file
Antoine Vandevenne (anv) fe894ad110 [IMP] odoo_theme: add the class o_code on literals
The SCSS that styles the `literal`, `code`, `file`, and `command` roles
is excessively complex because the traduction from RST to HTML is not
consistent from one role to another: some use `<code>` elements, some
have the `code` class, some wrap the literal with a `span` element.

This commit sets the `o_code` class on all of these roles' parent node
at translation time to allow simplifying the SCSS target.
2023-01-03 18:30:36 +01:00
.tx [FIX] *: enforce 1 newline on files end 2022-11-18 17:32:58 +01:00
content [FIX] rdtraining: fix writing errors 2023-01-03 10:56:22 +01:00
extensions [IMP] odoo_theme: add the class o_code on literals 2023-01-03 18:30:36 +01:00
locale [I18N] *: update source terms 2023-01-02 10:23:53 +01:00
redirects [IMP] contributing/documentation: rewrite the contribution guide 2023-01-02 18:47:52 +01:00
static [FIX] core: latex build 2022-12-16 00:58:41 +01:00
.gitattributes [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-28 18:02:06 +02:00
.gitignore [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-28 18:02:06 +02:00
commit_template.txt [FIX] *: enforce 1 newline on files end 2022-11-18 17:32:58 +01:00
conf.py [IMP] conf.py, *: interpolate the version and releases in the content 2022-12-08 11:46:38 +01:00
Makefile [FIX] core: latex build 2022-12-16 00:58:41 +01:00
README.md [IMP] README: remove version from links and rephrase explanations 2023-01-02 18:47:52 +01:00
requirements.txt [IMP] conf.py, requirements.txt, *: allow building with Python 3.10 2022-07-14 17:38:42 +02:00

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)

Instructions

  1. In a terminal, navigate to the root directory of the documentation and build it make. Additional commands are available with make help.
  2. Open the file documentation/_build/html/index.html in your web browser.
  3. See this guide for more detailed instructions.

Optional: place your local copy of the odoo/odoo repository 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.