Odoo documentation sources
Go to file
Antoine Vandevenne (anv) 120ae78553 [IMP] developer/views: apply the new API references style
The documentation of view attributes was lacking visual structure to
help the reader figure out which attribute relates to which parent
element. Since this documentation was relying on RST block quotes to
represent the hierarchy of view attributes, we can apply the same new
styling that was added with commit 934f45cf and designed for autodoc,
and which relies on the exact same HTML structure as block quotes.

task-2755298

closes odoo/documentation#2324

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-27 17:05:05 +02:00
.tx [MERGE] Forward port of 12.0 into 13.0 2021-06-14 16:04:49 +02:00
content [IMP] developer/views: apply the new API references style 2022-06-27 17:05:05 +02:00
extensions [IMP] developer/views: apply the new API references style 2022-06-27 17:05:05 +02:00
locale [I18N] Update translation terms from Transifex 2022-06-26 02:40:18 +02:00
redirects [IMP] redirects: split redirects.txt into multiple, per-version, files 2022-06-22 16:31:52 +02:00
static [IMP] contributing: update the rst cheat sheet 2022-06-27 12:43:35 +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 [IMP] odoo_theme: open images in a modal 2022-06-23 10:44:43 +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
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.