Odoo documentation sources
Go to file
Louis Baudoux d829aa19a0 [IMP] extract_api: uniformize API documentation across all versions
We used to document the extract API according to the version of the
documentation that is being viewed, i.e. in version 14, we
documented the API version that was used in Odoo 14.

This is actually not a good idea as the extract API isn't strictly
linked to Odoo versions, it has its own versioning system.

It can also be an issue if users don't realize they're viewing an old
version of the API and start implementing customizations based on it.

This commit is an exact copy of the current `master` version of the
extract API documentation.

closes odoo/documentation#6219

X-original-commit: f8adea7845
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Louis Baudoux (lba) <lba@odoo.com>
2023-10-26 11:07:39 +00:00
.tx [I18N] migrate to the nex transifex API 2023-02-09 16:28:50 +01:00
content [IMP] extract_api: uniformize API documentation across all versions 2023-10-26 11:07:39 +00:00
extensions [FIX] odoo_theme: fix logo colors 2023-08-24 13:17:38 +02:00
locale [I18N] *: export translations 2023-10-09 12:06:13 +00:00
redirects [IMP] website: Google Analytics 2023-09-11 06:24:50 +00:00
static [IMP] odoo_theme: design improvements 2023-04-12 09:58:52 +02:00
tests [ADD] tests: image compression and resource file name checkers 2023-08-09 10:22:32 +02:00
.gitattributes [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-28 19:31:32 +02:00
.gitignore [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-28 19:31:32 +02:00
commit_template.txt [FIX] *: enforce 1 newline on files end 2022-11-18 17:42:18 +01:00
conf.py [ADD] legal: update terms of sales for monthly subs, add ES,DE 2023-09-13 00:33:12 +00:00
COPYRIGHT [ADD] Add LICENSE and COPYRIGHT 2023-09-13 00:33:11 +00:00
LICENSE [ADD] Add LICENSE and COPYRIGHT 2023-09-13 00:33:11 +00:00
Makefile [ADD] tests: image compression and resource file name checkers 2023-08-09 10:22:32 +02:00
README.md [IMP] README: remove version from links and rephrase explanations 2023-01-03 10:19:42 +01:00
requirements.txt [IMP] conf.py, requirements.txt, *: allow building with Python 3.10 2022-07-14 20:32:20 +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.