Odoo documentation sources
Go to file
Odoo's Mergebot 934f45cf4d
[MERGE] odoo_theme: styling fixes, tweaks, and general cleanup
**Special terms restyling:**
A general restyling of special terms has been made for better legibility
in text, and to differentiate roles (ie: `:command:`,`:file:`,`:dfn:`)
so writers can use these instead of italic and bold styling.
`:guilabel:` has not been changed because its use is too vast.

task-2790284

**Reference pages have a new look:**
`code` elements have been restyled to remove unnecessary spaces (ex:
`odoo.models .BaseModel`. See
https://www.odoo.com/documentation/15.0/developer/reference/backend/orm.html#odoo.models.BaseModel)
and to include visual aid of parent/children relations (left border).

Basic for task-2755298

**URL styling:**
When an image has an external link, the `external-link` icon appears
under the image. This has been removed. URLs with icons such as external
links or "Edit on Github" links have been modified to remove the
underline under the icons. On mobile, long URLs would push the content
outside the viewport. `overflow-wrap: anywhere` has been added to all
URLs on mobile devices.

**No more horizontal scroll on Windows thanks to css grid:**
Windows and Mac don't work the same (no kidding). Windows would add
±`1rem` of horizontal scroll when Mac doesn't. Adding that `1rem` to the
content's `max-width` calculations would make Mac unhappy (it left a
`1rem` gap). The solution for everyone to be happy was to change the
display type to `grid`. By doing this, the max-width calculations and
the left positioning according to the side-nav were not necessary
anymore. Great Success. Very Nice.

**Scrolling To:**
With the new subnav added with commit 10f62b6a, the scroll position was
wrong. This is fixed by changing the padding/margin top values in the
`o-scroll-padding` mixin.

**Replace "Hide Search Matches" with close icon:**
The title says it all.

**Forgotten scrollbar styling**
The scrollbar stylings for the side-nav should have been moved to
`o_side_nav-inner` during the previous restyling of the header.

**Clean up the mess:**
All these changes made me want to clean up a bit. By doing so I realised
that a lot of the utility mixins that were used in the old *old* doc
were still present here, but aren't being used. Same for some variables.
Some stying was using values instead of their variable counterparts, so
these have been replaced.

closes odoo/documentation#2264

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-27 14:35:22 +02:00
.tx [MERGE] Forward port of 12.0 into 13.0 2021-06-14 16:04:49 +02:00
content [IMP] contributing: update the rst cheat sheet 2022-06-27 12:43:35 +02:00
extensions [REF] odoo_theme: replace values with variables in SCSS files 2022-06-27 14:24:54 +02:00
locale [I18N] Update translation terms from Transifex 2022-06-26 02:40:18 +02:00
redirects [IMP] redirects: split redirects.txt into multiple, per-version, files 2022-06-22 16:31:52 +02:00
static [IMP] contributing: update the rst cheat sheet 2022-06-27 12:43:35 +02:00
.gitattributes [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-28 15:24:20 +02:00
.gitignore [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-28 15:24:20 +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 10:44:43 +02:00
Makefile [IMP] odoo_theme: allow to add plausible script 2022-05-09 09:49:41 +02:00
README.md [IMP] README: remove request for review instruction 2021-12-09 13:21:47 +00:00
requirements.txt [FIX] requirements: pin docutils to 0.16.0 2022-06-09 13:58:41 +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.