Commit Graph

2418 Commits

Author SHA1 Message Date
Antoine Vandevenne (anv)
120ae78553 [IMP] developer/views: apply the new API references style
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

closes odoo/documentation#2324

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-27 17:05:05 +02:00
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
Elisabeth Dickinson
c82d95b17c [REF] odoo_theme: replace values with variables in SCSS files 2022-06-27 14:24:54 +02:00
Elisabeth Dickinson
7fa153594d [REF] odoo_theme: move stray mixins into the _mixins.scss file 2022-06-27 14:24:54 +02:00
Elisabeth Dickinson
fca78f44db [CLN] odoo_theme: remove unnecessary css 2022-06-27 14:24:54 +02:00
Elisabeth Dickinson
383e3d4206 [CLN] odoo_theme: remove old doc's unused variables 2022-06-27 14:24:54 +02:00
Elisabeth Dickinson
b9ca38215d [REF] odoo_theme: move scrollbar styling to .o_side_nav-inner 2022-06-27 14:24:54 +02:00
Elisabeth Dickinson
9a2e8eefef [CLN] odoo_theme: remove old doc's utility mixins
These mixins were used in the old doc and were kept "just in case". The
`valid-radius` mixin already exists in the bootstrap library.
2022-06-27 14:24:54 +02:00
Elisabeth Dickinson
994d273a59 [IMP] odoo_theme: replace "hide search matches" by a close button 2022-06-27 14:24:54 +02:00
Elisabeth Dickinson
794e42f78b [IMP] odoo_theme: improve spacing around code blocks on reference pages 2022-06-27 14:24:54 +02:00
Elisabeth Dickinson
0b536debac [FIX] odoo_theme: fix scrollTo margin/padding with new headers height
The scroll padding needed increasing with the new sub-header.
Unnecessary calc() and parenthesis on the headers-height variable are
removed.
2022-06-27 14:24:54 +02:00
Elisabeth Dickinson
26bc1cd707 [FIX] odoo_theme: remove the horizontal scroll bar 2022-06-27 14:24:54 +02:00
Elisabeth Dickinson
91cb3ca026 [IMP] odoo_theme: improve URL stylings
- Remove external-link icon on images.
- Remove underline from external-link icon on link hover.
- Add overflow-wrap on URLs on mobile.
2022-06-27 14:24:54 +02:00
Elisabeth Dickinson
2e693b3c4a [IMP] odoo_theme: improve general spacings and paddings 2022-06-27 14:24:54 +02:00
Elisabeth Dickinson
7239986484 [IMP] odoo_theme: improve special terms styling
Including the `:command:`, `:file:` and `:dfn:` roles, and code-styled
text in alerts.

task-2790284
2022-06-27 14:24:54 +02:00
Jonathan Castillo (jcs)
9ff312298d [IMP] contributing: update the rst cheat sheet
task - 2810468

closes odoo/documentation#1825

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Elisabeth Dickinson (edi) <edi@odoo.com>
2022-06-27 12:43:35 +02:00
Valentin Chevalier
0db39e3564 [ADD] payment_acquirers/adyen: add doc configuration of Adyen
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

closes odoo/documentation#1737

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-27 09:12:46 +02:00
Odoo Translation Bot
4f846a1f62 [I18N] Update translation terms from Transifex 2022-06-26 02:40:18 +02:00
LoredanaLrpz
610aeb1563 [ADD] pos: adyen payment terminal
Task ID: 2808584
Do not Forward port r+

closes odoo/documentation#2017

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-24 17:47:37 +02:00
LoredanaLrpz
63792faa92 [IMP] pos: change titles
Part-of: odoo/documentation#2017
2022-06-24 17:47:37 +02:00
Tom Aarab (toaa)
103c17f235 [IMP] accounting: added specification about payment flow for payment acquirer
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

closes odoo/documentation#2239

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-23 18:12:24 +02:00
Antoine Vandevenne (anv)
2a867b4f60 [IMP] odoo_theme: open images in a modal
task-2358082

closes odoo/documentation#1687

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Elisabeth Dickinson (edi) <edi@odoo.com>
2022-06-23 10:44:43 +02:00
Antoine Vandevenne (anv)
9e84b6f681 [FIX] odoo_theme: correctly test for fallback URLs when using switchers
closes odoo/documentation#2266

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-22 17:21:53 +02:00
Antoine Vandevenne (anv)
80c7b27827 [IMP] redirects: split redirects.txt into multiple, per-version, files
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

closes odoo/documentation#2265

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-22 16:31:52 +02:00
“Chiara
2c59116ef5 [REM] accounting: remove the odoo tutorials invoices link
Deleting the Odoo Tutorials Invoices link since the course has been merged, and the link isn't necessary anymore.

closes odoo/documentation#2243

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-06-20 16:45:06 +02:00
Elisabeth Dickinson
a689ea236d [FIX] odoo_theme: fix highlight blocks in field-list items
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.

closes odoo/documentation#2215

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-15 11:16:41 +02:00
Odoo's Mergebot
10f62b6a49
[MERGE] odoo_theme: revamp header and menu for better mobile support
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

closes odoo/documentation#2206

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-15 10:30:46 +02:00
Antoine Vandevenne (anv)
98e98f65c9 [FIX] odoo_theme: stop testing for valid URLs if in localhost
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 '/'.
2022-06-15 09:56:46 +02:00
Elisabeth Dickinson
3fd32fe92a [FIX] odoo_theme: fix searchbox's highlight-link
task-2800937
2022-06-15 09:56:16 +02:00
Elisabeth Dickinson
4ed8c2238a [IMP] odoo_theme: revamp side menu to add overlay
task-2800937
2022-06-15 09:56:07 +02:00
Elisabeth Dickinson
9c53901db9 [FIX] odoo_theme: fix menu scrolling
task-2800937
2022-06-15 09:55:55 +02:00
Elisabeth Dickinson
7284b11a36 [IMP] odoo_theme: add side menu collapse icon
task-2800937
2022-06-15 09:55:44 +02:00
Elisabeth Dickinson
dee96ad2da [IMP] odoo_theme: change collapsing menu orientation
task-2800937
2022-06-15 09:55:25 +02:00
Elisabeth Dickinson
411e1cb1d3 [IMP] odoo_theme: add subheader and adapt switchers and searchbar
task-2800937
2022-06-15 09:55:05 +02:00
Elisabeth Dickinson
b1fa30f431 [IMP] odoo_theme: stop translating language names in the switcher
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
2022-06-15 09:51:45 +02:00
Elisabeth Dickinson
343decf192 [IMP] design: add an icon behind external links
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

closes odoo/documentation#2167

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-14 11:42:13 +02:00
Elisabeth Dickinson
c0040fa532 [IMP] odoo_theme: show the "On this page" section in mobile
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

closes odoo/documentation#2179

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-13 14:53:08 +02:00
Odoo Translation Bot
fb700d98e8 [I18N] Update translation terms from Transifex 2022-06-12 02:40:20 +02:00
Antoine Vandevenne (anv)
5471d9a2ff [FIX] requirements: pin docutils to 0.16.0
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.

closes odoo/documentation#2169

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-09 13:58:41 +02:00
Denis Vermylen
1afee9e2c7 [FIX] odoo.sh: remove hidden folder from documentation
it will also be renamed to .repositories in the near future

closes odoo/documentation#2159

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-07 10:08:43 +02:00
Odoo Translation Bot
f9327efd33 [I18N] Update translation terms from Transifex 2022-06-05 02:40:16 +02:00
Jason Aerts (jaae)
6dc4288e49 [IMP] maintain: process for odoo.sh to odoo online
task-id 2870122

closes odoo/documentation#2133

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-06-03 12:29:48 +02:00
Tom Aarab (toaa)
e4fc5f07ee [IMP] accounting: add note about bank sync not available for trial db
Added a note to specify that bank synchronization is not available on trial databases

closes odoo/documentation#2122

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-06-02 09:54:03 +02:00
Jonathan Castillo (jcs)
4cd0500408 [IMP] maintain: add note in hosting changes (on-premise to online)
task-id 2869953

closes odoo/documentation#2123

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-06-01 17:37:04 +02:00
william
6d4f4f7d9b [FIX] conf: dynamic LaTeX releasename
closes odoo/documentation#2110

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-05-30 16:06:48 +02:00
Demesmaeker
80408caf6d [IMP] amazon: migrate to SPAPI
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

closes odoo/documentation#1654

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-30 09:44:12 +02:00
Odoo Translation Bot
0efff824d2 [I18N] Update translation terms from Transifex 2022-05-29 02:40:16 +02:00
Donatienne Pirlot
ffc23483ca [IMP] accounting: update the follow-up information
Task ID: 2735445

closes odoo/documentation#1834

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-24 13:40:02 +02:00
Odoo Translation Bot
8e7937a308 [I18N] Update translation terms from Transifex 2022-05-22 02:40:17 +02:00
Martin Trigaux
241fd5e76f [FIX] odoo_theme: correctly consider baseurl
urlBase was only containing the domain name, not the /documentation/

closes odoo/documentation#2054

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-20 11:47:20 +02:00