Odoo documentation sources
Go to file
Elisabeth Dickinson c8750ae032
[FIX] odoo_theme: fix header display on small screen widths
The highlight-link was pushing the header height to be on two lines.
It is now absolutely positioned below the searchbar instead of to its right.
The switchers now push themselves to the right instead of being pushed by the searchbar-wrapper.
2021-06-09 11:22:58 +02:00
.tx [I18N] *: export all .pot files 2021-05-14 16:55:06 +02:00
content [FIX] contributing: fix admonition padding 2021-06-04 17:44:23 +02:00
extensions [FIX] odoo_theme: fix header display on small screen widths 2021-06-09 11:22:58 +02:00
locale [I18N] Update translation terms from Transifex 2021-06-06 02:30:18 +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 [FIX] code: typos 2021-05-31 14:44:18 +02:00
Makefile [IMP] Makefile: update build instructions following merge of 46c21826 2021-06-04 13:49:20 +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.