![]() From now on, the master branch and the latest released SaaS branch are
always shown. SaaS branches are labeled "Odoo Online".
The list of the versions shown in the switcher is hard-coded to force
their ordering.
The class `dropdown-toggle` is always added to the version|language
switcher regardless of whether other versions|languages are available,
as a quick fix to a CSS issue that occurs when the class is missing.
closes odoo/documentation#1577
X-original-commit:
|
||
---|---|---|
.tx | ||
content | ||
extensions | ||
locale | ||
static | ||
.gitignore | ||
commit_template.txt | ||
conf.py | ||
Makefile | ||
README.md | ||
redirects.txt | ||
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 in 14.0 (Optional)
Instructions
-
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
. -
Open the file
documentation/_build/html/index.html
in your web browser to display the render. -
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.