Odoo documentation sources
Go to file
Antoine Vandevenne (anv) 46cb0b8e9b [IMP] developer/*: replace occurrences of "access rule" by "record rule"
Both the functional and technical name of the `ir.rule` model is "Record
Rule". This commit makes sure that all occurrences of "Access Rule" are
replaced by the correct name "Record Rule" as it was easily confused
with "Access Rights".

Original PR: https://github.com/odoo/documentation/pull/1118

closes odoo/documentation#1421

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-12-15 13:08:40 +00:00
.tx [MERFE] Froward port of 13.0 to 14.0 2021-06-14 16:11:22 +02:00
content [IMP] developer/*: replace occurrences of "access rule" by "record rule" 2021-12-15 13:08:40 +00:00
extensions [MERGE] Forward-port of branch 13.0 to 14.0 2021-07-07 15:39:35 +02:00
locale [I18N] Update translation terms from Transifex 2021-12-12 01:31:02 +01:00
static [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-31 14:54:23 +02:00
.gitignore [FIX] makefile: fix overridden css 2021-08-05 08:46:48 +00: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.py: check odoo_dir is a real Odoo sources dir 2021-11-26 12:51:42 +00:00
Makefile [FIX] Makefile: avoid confusing // in build dir path 2021-08-06 15:12:56 +00:00
README.md [IMP] README: remove request for review instruction 2021-12-09 13:38:16 +00:00
redirects.txt [IMP] upgrade: create new "upgrade" section in "install and maintain" 2021-10-15 11:40:55 +00:00
requirements.txt [FIX] requirements.txt: Let sphinx manage docutils version 2021-11-03 10:45:29 +00: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.