547d90a97d
Building documentation implies some constraints: the source folder is readonly, mainly because the sources are shared accros builds. This implies that nor a symlink and a _build dir cannot be added in the source directory. The symlink will work in most cases localy for user with strange multiverse structure, but if not found, the fallback will check in parent directory. Most users and runbot will have all sources in the same directory (both in universe and basic multiverse cases) -(version?) -odoo -enterprise -upgrade -documentation The second change will check if BUILD_DIR is defined before setting it, allowing to use 'make BUILD_DIR=../build' to output the documentation somewhere else. |
||
|---|---|---|
| .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 12.0 (Optional)
Instructions
-
In a terminal, navigate to the root directory and compile the documentation to HTML with the following command:
makeAdditional commands are available with
make help. -
Open the file
documentation/_build/html/index.htmlin 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.
If you have a pull request that is ready for review, request one from the odoo/doc-review team.