Odoo documentation sources
Go to file
Antoine Vandevenne (anv) 7459432e02 [FIX] requirements.txt: pin Jinja2 < 3.1
The latest versions of Jinja2 are no longer compatible with the latest
version of Sphinx 3 (3.5.4).

task-2828982

X-original-commit: 8f4be8e3ea
2022-05-12 18:47:44 +02:00
.tx [MERFE] Froward port of 13.0 to 14.0 2021-06-14 16:11:22 +02:00
content [IMP] sale_management: remove price_unit from quotation template 2022-05-10 14:39:42 +02:00
extensions [IMP] odoo_theme: allow to add plausible script 2022-05-09 11:26:16 +02:00
locale [I18N] Update translation terms from Transifex 2022-05-08 02:40:16 +02:00
static [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-31 14:54:23 +02:00
.gitattributes [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-28 17:46:58 +02:00
.gitignore [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-28 17:46:58 +02:00
commit_template.txt [IMP] base: add a commit message template with the guidelines 2020-01-16 14:17:37 +01:00
conf.py [REM] extensions: remove the 'switcher' extension 2022-03-11 14:14:16 +00:00
Makefile [IMP] odoo_theme: allow to add plausible script 2022-05-09 11:26:16 +02:00
README.md [IMP] README: remove request for review instruction 2021-12-09 13:38:16 +00:00
redirects.txt [FIX] upgrade: small fixes 2022-03-29 11:25:56 +02:00
requirements.txt [FIX] requirements.txt: pin Jinja2 < 3.1 2022-05-12 18:47:44 +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.