Odoo documentation sources
Go to file
Xavier-Do 547d90a97d [IMP] allow to define BUILD_DIR and better odoo detection
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.
2021-07-20 10:48:37 +02:00
.tx [FIX] conf: translate the theme 2021-06-14 15:00:16 +02:00
content [IMP] admin/odoo.sh: supported versions in "getting_started/create" 2021-06-24 16:48:17 +02:00
extensions [IMP] extension: mark HTML content as translatable 2021-06-14 15:01:01 +02:00
locale [I18N] Update translation terms from Transifex 2021-06-27 02:30:52 +02:00
static [FIX] code: typos 2021-05-31 14:44:18 +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 [IMP] allow to define BUILD_DIR and better odoo detection 2021-07-20 10:48:37 +02:00
Makefile [IMP] allow to define BUILD_DIR and better odoo detection 2021-07-20 10:48:37 +02:00
README.md [IMP] README: update links according to redirects made in 675f7bc8 2021-06-07 08:43:55 +02:00
redirects.txt [IMP] contributing: flatten hierarchy of "documentation" pages 2021-06-04 17:44:23 +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.