Need help with documentation-user?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

odoo
278 Stars 2.2K Forks 2.3K Commits 48 Opened issues

Description

📚 Odoo documentation sources

Services available

!
?

Need anything else?

Contributors list

Odoo documentation

Build the documentation locally

Requirements

Instructions

  1. In a terminal, navigate to the root directory and compile the documentation to HTML with the following command:
   make

Additional commands are available with

make help
.
  1. Open the file

    documentation/_build/html/index.html
    in your web browser to display the render.
  2. 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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.