Odoo documentation sources
2ca32b40bc
Add a new content focused on SCSS and user-interface. - SCSS coding guidelines: regroup information already available (eg [1]) or based on "oral tradition". The aim is not to establish new rules, ~99% of the current codebase is already compliant. - SCSS inheritance: explain how SCSS assets management works in odoo. For example, people still find confusing that overrides are defined *before* the variable to customize. - SCSS optimization tips: suggestions to lean SCSS code. Based on SCSS optimization task's know-how [2]. - CSS variables: explain how this feature is commonly used in odoo to adapt layout & design without raw CSS overrides. - UI Icons: Add link to fontAwesome4 library . Replace the picture of odoo icons with the actual font (90kb image VS 15Kb font) [1] https://github.com/odoo/odoo/wiki/SCSS-coding-guidelines [2] https://www.odoo.com/web#id=2704984&menu_id=4720&cids=1&model=project.task&view_type=form task-3090800 closes odoo/documentation#3093 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.htmlin 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.