Odoo documentation sources
![]() The aim of this cleanup is to use as many bootstrap classes, functions and utilities as possible to reduce the amount of extra code. Instead of redefining variables, BS variables are overridden in the bootstrap_overridden file. In order to be able to reuse these overridden variables within our own custom variable file — and after consultation with SRI — it was determined that the variables.scss file should come after the bootstrap files in the order of importation, unlike the order of odoo website's scss files. Changes to variables in bootstrap_overridden have been made to adapt to the new structure. |
||
---|---|---|
.tx | ||
content | ||
extensions | ||
locale | ||
redirects | ||
static | ||
.gitattributes | ||
.gitignore | ||
commit_template.txt | ||
conf.py | ||
Makefile | ||
README.md | ||
requirements.txt |
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
- In a terminal, navigate to the root directory of the documentation and build it
make
. Additional commands are available withmake help
. - Open the file
documentation/_build/html/index.html
in your web browser. - 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.