Odoo documentation sources
Go to file
Odoo's Mergebot 180fb8a633
[MERGE] odoo_theme: SCSS code clean up
In order to reduce the size of our css files:
Some unused or repeated code was found and removed.
Variables have been cleaned up, the way the admonitions (alerts) were created has been modified,

Expanding the use of BS variables in order to reduce repeated code and to stay consistent in the general design.
Sphinx was updated which made some changes in the DOM, breaking some of the CSS:
the literals for example, these have been fixed in this PR.
The font sizes were breaking the typescale, this has been fixed by modifying the typescale
rather than hardcoding font sizes.

closes odoo/documentation#3285

Forward-port-of: odoo/documentation#3268
Forward-port-of: odoo/documentation#3225
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-04 11:58:00 +01:00
.tx [FIX] *: enforce 1 newline on files end 2022-11-18 17:42:18 +01:00
content [FIX] maintain: correct cname definition 2023-01-04 00:13:47 +01:00
extensions [IMP][CSS] Replace text-decoration on link with BS override 2023-01-04 11:10:09 +01:00
locale [FIX] inventory_and_mrp: documentation update 2022-04-21 16:47:21 +02:00
redirects [IMP] contributing/documentation: rewrite the contribution guide 2023-01-03 10:19:42 +01:00
static [FIX] core: latex build 2022-12-15 18:47:18 +01:00
.gitattributes [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-28 19:31:32 +02:00
.gitignore [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-28 19:31:32 +02:00
commit_template.txt [FIX] *: enforce 1 newline on files end 2022-11-18 17:42:18 +01:00
conf.py [IMP] conf.py, *: interpolate the version and releases in the content 2022-12-08 13:55:59 +01:00
Makefile [FIX] core: latex build 2022-12-15 18:47:18 +01:00
README.md [IMP] README: remove version from links and rephrase explanations 2023-01-03 10:19:42 +01:00
requirements.txt [IMP] conf.py, requirements.txt, *: allow building with Python 3.10 2022-07-14 20:32:20 +02:00

Odoo documentation

Build the documentation locally

Requirements

  • Git
  • Python 3.6, 3.7, or 3.8
  • Python dependencies listed in the file requirements.txt.
  • Make
  • A local copy of the odoo/odoo repository (optional)

Instructions

  1. In a terminal, navigate to the root directory of the documentation and build it make. Additional commands are available with make help.
  2. Open the file documentation/_build/html/index.html in your web browser.
  3. See this guide for more detailed instructions.

Optional: place your local copy of the odoo/odoo repository in the parent directory or in the root directory of the documentation to build the latter with the documented Python docstrings.

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.

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.