Odoo documentation sources
![]() Just some small RST tweaks, so the PR can pass the minimal checks and align with the marketing team's guidelines: - Wrapped lines to stay within the 100-character limit. - Removed the align tag from images (we no longer use it). - Cleaned up extra whitespace on empty lines. |
||
---|---|---|
.tx | ||
content | ||
extensions | ||
locale | ||
redirects | ||
static | ||
tests | ||
.gitattributes | ||
.gitignore | ||
commit_template.txt | ||
conf.py | ||
COPYRIGHT | ||
LICENSE | ||
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)
- A local copy of the odoo/upgrade-util 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
and odoo/upgrade-util
repositories 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.