Odoo documentation sources
Go to file
Claire Bretton (clbr) 0fab281c12 [IMP] getting_started: use odoo/tutorials repository + runbot
We now use the odoo/tutorials to make the technical onboarding.
- Change the current documentation accordingly.
- Add a section for employees only so that they use odoo-dev/tutorials
as shared fork. It's closer to our way to work so we think it's better
to make them use to it as fast as possible.
- Add some explanations about runbot.

`odoo/technical-training-sandbox` will no longer be used and can be considered deprecated.

closes odoo/documentation#8043

X-original-commit: e60affa6fe
Signed-off-by: Claire Bretton (clbr) <clbr@odoo.com>
2024-03-06 11:37:58 +00:00
.tx [I18N] *: export 17.0 translations 2023-11-08 12:17:46 +00:00
content [IMP] getting_started: use odoo/tutorials repository + runbot 2024-03-06 11:37:58 +00:00
extensions [FIX] odoo_theme: add bottom margin to inner lists 2024-02-14 11:03:48 +00:00
locale [IMP] fiscal_localizations: HMRC format improved 2024-03-01 13:12:04 +00:00
redirects [REF] marketing automation: move getting started 2024-02-13 16:01:21 +00:00
static [FIX] accounting: cheat sheet reconcile 2023-12-13 14:39:19 +00:00
tests [IMP] tests: make review UX and resource files 2023-11-14 02:35:55 +00: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 [IMP] supported_versions: release saas-17.1 2024-02-14 05:10:11 +00:00
COPYRIGHT [ADD] Add LICENSE and COPYRIGHT 2023-09-13 04:37:09 +00:00
LICENSE [ADD] Add LICENSE and COPYRIGHT 2023-09-13 04:37:09 +00:00
Makefile [IMP] tests: make review UX and resource files 2023-11-14 02:35:55 +00:00
README.md [IMP] README: remove version from links and rephrase explanations 2023-01-03 20:14:55 +01:00
requirements.txt [FIX] requirements: fix sphinxcontrib versions 2024-01-16 19:28:39 +00: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.