Odoo documentation sources
Go to file
chyde-clearwater 302c373994 [IMP] tutorials/getting_started: disambiguate example model name
I removed the dot notation in the  "_name" variable for the example
model. AKA, "test.model" is now named "test_model".

Dot notation implies a data structure relationship between a <model> and
it's parent (or class etc) <test> (like test.model() or Test.model).
There is no relationship like this between a <test> and <model> - it's
just one thing: a <test model>.

The seeming "benefit" of the ORM translating dots to underscores doesn't
justify this naming convention.  Yes, I know it's a string, but still,
this seems confusing for newbies and adds unnecessary complexity (why
name the same thing differently in different places?)

closes odoo/documentation#5140

X-original-commit: f36c612d13
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-07-18 15:38:33 +02:00
.tx [I18N] theme: remove reference to translation 2023-03-09 12:00:58 +01:00
content [IMP] tutorials/getting_started: disambiguate example model name 2023-07-18 15:38:33 +02:00
extensions [FIX] odoo_theme/switchers: fallback to the original target URL 2023-07-07 17:47:57 +02:00
locale [I18N] *: export translations 2023-07-10 15:38:40 +02:00
redirects [DEL] MRP: Delete Alternative Work Centers 16.0 2023-07-13 22:37:13 +02:00
static [IMP] odoo_theme: design improvements 2023-04-12 12:26:14 +02:00
tests [ADD] tests: image size checker 2023-04-11 15:17:26 +02:00
.gitattributes [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-29 11:01:52 +02:00
.gitignore [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-29 11:01:52 +02:00
commit_template.txt [FIX] *: enforce 1 newline on files end 2022-11-18 18:04:49 +01:00
conf.py [FIX] werkzeug version 2023-06-09 01:20:27 +02:00
Makefile [REL] saas-16.3 2023-05-17 16:01:11 +02:00
README.md [IMP] README: remove version from links and rephrase explanations 2023-01-03 20:14:55 +01:00
requirements.txt [FIX] requirements: bump libsass to match odoo 2023-05-16 08:24:19 +02:00

Odoo documentation

Build the documentation locally

Requirements

  • Git
  • Python 3.6, 3.7, or 3.8
  • Python dependencies listed in the file requirements.txt.
  • Make
  • A local copy of the odoo/odoo repository (optional)

Instructions

  1. In a terminal, navigate to the root directory of the documentation and build it make. Additional commands are available with make help.
  2. Open the file documentation/_build/html/index.html in your web browser.
  3. See this guide for more detailed instructions.

Optional: place your local copy of the odoo/odoo repository in the parent directory or in the root directory of the documentation to build the latter with the documented Python docstrings.

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.

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.