Odoo documentation sources
Go to file
Antoine Vandevenne (anv) 4e67b8986c [MOV] developer/misc: move all pages to a more logical location
Before this commit, the "Developer/Misc" directory of the doc, and
more particularly the "Developer/Misc/Other" sub-directory, was used as
a garbage dump where we moved all the pages that didn't fit elsewhere.
Due to that, interesting and important pages, such as the Coding
Guidelines, were buried in that directory never to be read again by Odoo
developers.

This commit moves most pages under "Misc" one or two levels up to be
located directly under "Developer" hence making them more accessible. A
new "Contributing/Development" directory is added to host the Coding
Guidelines page and soon many other pages.

task-2897143

closes odoo/documentation#2350

X-original-commit: ad374af15d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-04 10:38:45 +02:00
.tx [MERFE] Froward port of 13.0 to 14.0 2021-06-14 16:11:22 +02:00
content [MOV] developer/misc: move all pages to a more logical location 2022-07-04 10:38:45 +02:00
extensions [MOV] developer/misc: move all pages to a more logical location 2022-07-04 10:38:45 +02:00
locale [I18N] Update translation terms from Transifex 2022-06-12 02:40:17 +02:00
redirects [MOV] developer/misc: move all pages to a more logical location 2022-07-04 10:38:45 +02:00
static [IMP] contributing: update the rst cheat sheet 2022-06-27 14:35:12 +02:00
.gitattributes [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-28 17:46:58 +02:00
.gitignore [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-28 17:46:58 +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] odoo_theme: open images in a modal 2022-06-23 14:05:11 +02:00
Makefile [IMP] odoo_theme: allow to add plausible script 2022-05-09 11:26:16 +02:00
README.md [IMP] README: remove request for review instruction 2021-12-09 13:38:16 +00:00
requirements.txt [FIX] requirements: pin docutils to 0.16.0 2022-06-09 15:58:02 +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.