Odoo documentation sources
Go to file
Victor Feyens 2ddac026f1 [FIX] extensions: support parallel read
Now that patchqueue was removed, we can consider supporting the parallel 
read with our local extensions.

Since we only have basic extensions, not storing any data on the build 
environment, the change mainly consists of specifying the extensions as 
parallelizable.

The only specific case is the html domain, since the base html domain 
requires the support of the method merge_domaindata in parallel read 
mode.  Since we do not need to share anything between the envs for this 
extension, we can simply ignore the method.
2021-05-19 15:03:39 +02:00
.tx [I18N] *: export all .pot files 2021-05-14 16:55:06 +02:00
content [IMP] *: links improvements 2021-05-17 15:32:24 +02:00
extensions [FIX] extensions: support parallel read 2021-05-19 15:03:39 +02:00
locale [I18N] *: export all .pot files 2021-05-14 16:55:06 +02:00
static [REF][MOV] documentation apocalypse 2021-05-04 15:44:00 +02:00
.gitignore [REF][MOV] documentation apocalypse 2021-05-04 15:44:00 +02:00
commit_template.txt [IMP] base: add a commit message template with the guidelines 2020-01-16 14:17:37 +01:00
conf.py [FIX] translate the documentation 2021-05-14 16:55:06 +02:00
Makefile [FIX] translate the documentation 2021-05-14 16:55:06 +02:00
README.md [IMP] README: update README and translate it to Markdown 2021-05-12 18:20:48 +02:00
redirects.txt [FIX] redirects: odoo_sh documentation page 2021-05-17 15:36:08 +02:00
requirements.txt [REM] *: patchqueue extension 2021-05-10 17:24:23 +02:00

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.

  2. Open the file documentation/_build/html/index.html in your web browser to display the render.

  3. 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.