Odoo documentation sources
![]() In order to reduce the size of our css files: Some unused or repeated code was found and removed. Variables have been cleaned up, the way the admonitions (alerts) were created has been modified, Expanding the use of BS variables in order to reduce repeated code and to stay consistent in the general design. Sphinx was updated which made some changes in the DOM, breaking some of the CSS: the literals for example, these have been fixed in this PR. The font sizes were breaking the typescale, this has been fixed by modifying the typescale rather than hardcoding font sizes. closes odoo/documentation#3293 Forward-port-of: odoo/documentation#3290 Forward-port-of: odoo/documentation#3225 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> |
||
---|---|---|
.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.