Odoo documentation sources
Go to file
Olivier Dony 34101de7e4
[IMP] legal: make PDF links relative
This way we don't need to update the links nor risk a desynchronization
between the version of the PDF and the HTML.

Previously version 15.0 and 16.0 still referenced the 14.0 PDFs
(which are the same at the moment, but still...)
2022-10-19 19:07:10 +02:00
.tx [MERFE] Froward port of 13.0 to 14.0 2021-06-14 16:11:22 +02:00
content [IMP] legal: make PDF links relative 2022-10-19 19:07:10 +02:00
extensions [IMP] conf.py, requirements.txt, *: allow building with Python 3.10 2022-07-14 16:39:48 +02:00
locale [I18N] Update translation terms from Transifex 2022-10-16 02:40:22 +02:00
redirects [MOV] developer/misc: move all pages to a more logical location 2022-07-04 10:38:45 +02:00
static [REF] legal: convert the table from a grid to a list table 2022-07-13 14:27:32 +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 [IMP] supported_version: release 16.0 and deprecate 13.0 2022-10-12 06:05:47 +02: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
requirements.txt [IMP] conf.py, requirements.txt, *: allow building with Python 3.10 2022-07-14 16:39:48 +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.