4fb6c72d75
Since odoo/odoo@794677fb6a Odoo requires python 3.7 min. However, it still runs fine in 3.6 and this is the python version of the build server. Fake the version to be able to build the doc on the nightly server. To be removed once the nightly server is migrated. closes odoo/documentation#1257 Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
Odoo documentation
Build the documentation locally
Requirements
- Git
- Python 3.7 or 3.8
- Python dependencies listed in the file
requirements.txt. - Make
- A local copy of the odoo/odoo repository in 15.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.