Odoo documentation sources
Go to file
Antoine Vandevenne (anv) 68762e9856 [IMP] install: guide the user through the login page
Developers sometimes have a hard time making the difference between the
PostgreSQL user and the internal user. They would try to log into Odoo's
web client with their PostgreSQL credentials rather than with admin. See
https://reddit.com/r/Odoo/comments/w8zubf/logging_in_on_source_install.

closes odoo/documentation#2544

X-original-commit: 4558be3a5e
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-08-01 18:03:00 +02:00
.tx [I18N] *: export source terms 2022-03-18 16:04:17 +01:00
content [IMP] install: guide the user through the login page 2022-08-01 18:03:00 +02:00
extensions [IMP] conf.py, requirements.txt, *: allow building with Python 3.10 2022-07-14 17:38:42 +02:00
locale [I18N] Update translation terms from Transifex 2022-07-31 01:40:37 +02:00
redirects [IMP] studio: complete update of Studio 2022-07-28 09:41:41 +02:00
static [REF] legal: convert the table from a grid to a list table 2022-07-13 18:36:00 +02:00
.gitattributes [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-28 18:02:06 +02:00
.gitignore [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-28 18:02:06 +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] accounting_localization: use relative paths in csv-table's option 2022-07-14 17:38:42 +02:00
Makefile [IMP] odoo_theme: allow to add plausible script 2022-05-09 11:44:17 +02:00
README.md [IMP] README: remove request for review instruction 2021-12-09 13:38:12 +00:00
requirements.txt [IMP] conf.py, requirements.txt, *: allow building with Python 3.10 2022-07-14 17:38:42 +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.

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.