The documentation of view attributes was lacking visual structure to
help the reader figure out which attribute relates to which parent
element. Since this documentation was relying on RST block quotes to
represent the hierarchy of view attributes, we can apply the same new
styling that was added with commit 934f45cf and designed for autodoc,
and which relies on the exact same HTML structure as block quotes.
task-2755298
closesodoo/documentation#2324
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
**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.
closesodoo/documentation#2264
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Following a technical task regarding the migration of the Adyen hosted
payment page integration to Adyen PayByLink, some new parameters have
been introduced and some have been removed.
This new addition to the documentation will help users configure their
acquirer.
task-2802921
closesodoo/documentation#1737
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
V13 and V14 do not allow customers with no account on Odoo.com portal to pay through payment acquirers with payment flow "Payment from Odoo"
task - 2711962
closesodoo/documentation#2239
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The `redirects.txt` file used to specify redirect rules for renamed or
moved documentation pages is starting to grow too big to be easily
maintainable. The main reason is that the number of redirect rules that
were thought to be required has been largely underestimated when
implementing the 'redirects' extension. At first, we believed that no
guidelines or structure were necessary because only a small amount of
redirect rules would be specified. This proved wrong and the file is now
becoming a mess, making it increasingly difficult to figure out where,
why, when, and if a redirect rule is specified in the file.
As the file is versioned, another issue emerges: conflicts occur every
time a commit is forward-ported to a later version if that commit adds a
redirect rule at the end of the file or at a line that was changed in
the later version. As redirect rules are frequently added, and since
blocks of redirect rules for new versions are added at the end of the
file, this tends to happen a lot.
This commit attempts to hit two birds with one stone by splitting the
`redirects.txt` file into multiple files, one per version. While doing
so, the existing redirect rules are ordered alphabetically and moved
into contextual blocks. Instructions and guidelines on how to create
redirect rules are also listed in the `redirects/MANUAL.md` file. By
sorting the redirect rules and adding them in different files, the
number of conflicts should decrease by a lot.
task-2891912
closesodoo/documentation#2265
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Deleting the Odoo Tutorials Invoices link since the course has been merged, and the link isn't necessary anymore.
closesodoo/documentation#2243
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
On pages such as /developer/reference/backend/orm.html#fields, the
highlight blocks inside `dl.field-list` items were pushing the width of
the page to go outside the screen on mobile. This is fixed by changing
the `.field-list`'s `display: grid` into `block` on mobile.
closesodoo/documentation#2215
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Previously the switchers were hidden on mobile. These have been moved
to a sub-nav which also contains the button for the sidenav, leaving
more space for the searchbox so it can remain in the header. Like MDN
web docs, the navigation now slides in from the left instead of the
top.
See PR's commits for more details.
task-2800937
closesodoo/documentation#2206
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The mechanism that makes the version and language switchers test for
valid URLs crashed when testing in localhost. The mechanism is now
skipped if the URL starts with a '/'.
Before this commit, the language names were translated to display
"Français" instead of "French". This helped the user find their language
in the switcher but it was taking too much horizontal space, and that
space was not constant from one language to another.
This commit removes the translations of the language names and simply
goes with "FR", "NL", etc. which any user can identify as their
language.
task-2800937
The external links' target attribute is now also updated to open the
link in a new tab. In addition, the "[source]" link of autodoc's models
is moved right next to the name of the model to correctly position the
icon.
task-2790244
closesodoo/documentation#2167
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
When the page gets too small for the "On this page" section (local tree
of content) to fit on the page, the section is now moved above the menu
(global tree of content) rather than being hidden.
task-2800970
closesodoo/documentation#2179
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
Since sphinx-tabs 3.2.0 has the requirement docutils==0.16.0 and sphinx
3.5.4 has the requirement docutils>=0.12,<0.17, this commit pins
docutils to version 0.16.0.
While we're at it, the dependency to sphinx-tabs is also explicitly
listed, although it was already imported in the extensions. It causes
no trouble to install it from pip alongside the imported extension.
closesodoo/documentation#2169
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Added a note to specify that bank synchronization is not available on trial databases
closesodoo/documentation#2122
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Starting July 2022, Amazon WMS API is deprecated and we need to use the Selling Partners API.
This brings changes in the authentication flow that are explained.
task-2466636
closesodoo/documentation#1654
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
urlBase was only containing the domain name, not the /documentation/
closesodoo/documentation#2054
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
