Odoo documentation sources
f69dba70be
1) PDF files are generated and stored at the root of the CURRENT_BRANCH directory. The links to those files are generated at different levels of the doctree, which makes it impossible to use a relative path. For example the same "Enterprise Agreement" doc in EN is published on: - /16.0/legal/terms/enterprise.html - /16.0/fr/legal/terms/enterprise.html As a workaround, use absolute links for the PDFs. They won't work locally for now. Can be improved later, as long as we don't break those links located in various depths of the troctree. 2) The legal constracts aren't translated in all availables languages (yet), so those links are 404s now. Introduced a conf.py variable `legal_translations` with the list of languages where translated contracts are indeed available, and falling back to the EN version otherwise. Some languages don't have *all* the contracts translated, so some 404 may remain temporarily. |
||
|---|---|---|
| .tx | ||
| content | ||
| extensions | ||
| locale | ||
| redirects | ||
| static | ||
| tests | ||
| .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.