Odoo documentation sources
Go to file
Elisabeth Dickinson 343decf192 [IMP] design: add an icon behind external links
The external links' target attribute is now also updated to open the
link in a new tab. In addition, the "[source]" link of autodoc's models
is moved right next to the name of the model to correctly position the
icon.

task-2790244

closes odoo/documentation#2167

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-14 11:42:13 +02:00
.tx [MERGE] Forward port of 12.0 into 13.0 2021-06-14 16:04:49 +02:00
content [FIX] odoo.sh: remove hidden folder from documentation 2022-06-07 10:08:43 +02:00
extensions [IMP] design: add an icon behind external links 2022-06-14 11:42:13 +02:00
locale [I18N] Update translation terms from Transifex 2022-06-12 02:40:20 +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 15:24:20 +02:00
.gitignore [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-28 15:24:20 +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 [FIX] conf: dynamic LaTeX releasename 2022-05-30 16:06:48 +02:00
Makefile [IMP] odoo_theme: allow to add plausible script 2022-05-09 09:49:41 +02:00
README.md [IMP] README: remove request for review instruction 2021-12-09 13:21:47 +00:00
redirects.txt [FIX] upgrade: small fixes 2022-03-29 10:11:55 +02:00
requirements.txt [FIX] requirements: pin docutils to 0.16.0 2022-06-09 13:58:41 +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.