Odoo documentation sources
Go to file
2022-12-11 01:40:13 +01:00
.tx [FIX] *: enforce 1 newline on files end 2022-11-18 17:32:58 +01:00
content [ADD] marketing automation: added 'getting started' section and docs to round out documentation 2022-12-08 17:19:07 +01:00
extensions [IMP] documentation: legal page design 2022-12-07 15:21:24 +01:00
locale [I18N] Update translation terms from Transifex 2022-12-11 01:40:13 +01:00
redirects [FIX] *: remove trailing whitespaces 2022-11-18 17:32:59 +01:00
static [IMP] documentation: legal page design 2022-12-07 15:21:24 +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 [IMP] odoo_theme: allow to add plausible script 2022-05-09 11:44:17 +02:00
README.md [FIX] *: enforce 1 newline on files end 2022-11-18 17:32:58 +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

Instructions

  1. In a terminal, navigate to the root directory and compile the documentation to HTML with the following command:

    make
    

    Additional commands are available with make help.

  2. Open the file documentation/_build/html/index.html in your web browser to display the render.

  3. 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.