f72e557f2c
In `conf.py`, we try to find a Odoo sources folder among `odoo` and `../odoo` directories without really checking that they really are Odoo sources folders, leading to doc generation error if it's not the case. So, to improve that, this commit checks that the selected Odoo sources folder contains `odoo-bin`. While we're at it, the logging is also improved to always display the matching odoo sources' folder and version. closes odoo/documentation#1333 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
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 13.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.
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.