Commit Graph

2811 Commits

Author SHA1 Message Date
Benoit Socias
78945bf22e [IMP] rdtraining: update float utils information
The warning about float utils does not state where to find them, and
they are preceded by an example in the code that infringes the warning's
recommendation.

This commit indicates where to find the float utils and replaces the
example by one that uses them.

task-2925402

closes odoo/documentation#2511

X-original-commit: b8ee134a28
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-20 13:36:49 +02:00
Romain Derie
404c731d8b [FIX] website: warn about google api deprecation
Google deprecated both its "Universal Analytics" and "Google Sign-In"
API. See community counterpart commit for a detailed explanation and
links.

closes odoo/documentation#2497

X-original-commit: 0d01565ac3
Related: odoo/odoo#96271
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Romain Derie (rde) <rde@odoo.com>
2022-07-19 15:05:13 +02:00
Benoit Socias
c40cf83073 [IMP] install: troubleshoot typical problems for Mac users
As mentioned in [1], because of [2], some python implementation for Mac
fail on startup with default parameters.

Also, when installing requirements, the psycopg requirement can fail
because the $PATH does not contain the postgresql tools installed with
the .app.

This commit provides instructions to avoid those issues.

[1]: https://github.com/odoo/odoo/issues/79112
[2]: https://bugs.python.org/issue40518

task-2922249

closes odoo/documentation#2503

X-original-commit: 77f4b4b307
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-19 12:14:08 +02:00
Stanislas Sobieski
7c3c8335ee [IMP] install/maintain: update info about upgrade process on Odoo.sh
closes odoo/documentation#2492

Id: 2744270
X-original-commit: 815acb64c4
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
Co-authored-by: Stanislas <sts@odoo.com>
Co-authored-by: Donatienne <dopi@odoo.com>
2022-07-18 12:06:43 +02:00
Victor Feyens
2ed6704b88 [FIX] accounting_localization: use relative paths in csv-table's option
The `file` option for the `csv-table` directive expects relative file
paths rather than absolute file paths since Sphinx 4. Since this was the
only usage of the `ODOO_ABSPATH` placeholder, it is removed with this
commit.

Task - 2898477

closes odoo/documentation#2483

X-original-commit: 60adfacbc9
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-07-14 22:21:58 +02:00
Victor Feyens
bd34ada679 [IMP] conf.py, requirements.txt, *: allow building with Python 3.10
- Bump Sphinx version to 4.3.2 (default for Debian Jammy).
- Remove the retrocompatibility for Sphinx < 3.5 (warnings are raised in
  4.5).
- Fix translator issue crashing builds.
- Unpin jinja2 from the requirements as the base issue is solved in sphinx 4

Task - 2898477

X-original-commit: 217dba8bbe
Part-of: odoo/documentation#2483
2022-07-14 22:21:58 +02:00
Michelle Vu (mivu)
84779e5852 [IMP] helpdesk: clarify postpaid support and delete mentions of tasks
If committed, this will delete mentions of project tasks in the "Invoice
Time Spent on Tickets (Postpaid Support Services)" v14.0 user doc. It
also deletes unnecessary steps and screenshots about creating and
configuring a new Project and updates the steps and screenshots for the
"Create a sales order" and "Link the Helpdesk ticket to the SO" sections.

Fixes PR #1901
Closes Odoo Task 2870104

closes odoo/documentation#2477

X-original-commit: 521cee8aa0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-14 11:05:23 +02:00
Sam Lieber (sali)
9ba4aff8d8 [ADD] maintain: google oauth doc
Added document and media files on the setup of Google Gmail using OAuth with Odoo.

closes odoo/documentation#2472

X-original-commit: 9b75dfd2ac
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-14 11:05:20 +02:00
Antoine Vandevenne (anv)
ab55a5eda4 [REF] legal: convert the table from a grid to a list table
Prior to this commit, the /legal.html page relied on RST substitutions
to insert the images directives of legal agreements within the table.
This caused Sphinx to omit the `image-reference` class on all `<a>`
elements surrounding an `<img>` element, which it normally adds when the
`target` option is specified on an `image` directive. As the theme
relies on that class to hide the "external link" icon added with commit
343decf1, the layout of the page was broken.

While replacing the substitutions with the plain `image` directive, the
grid table is converted to a list table to avoid the hassle of expanding
table cells to fit the directives. This will also help in maintaining
the content of the table when we will add new translations for the legal
agreements.

task-2909167

closes odoo/documentation#2465

X-original-commit: 81bf067ba1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-13 16:48:23 +02:00
Antoine Vandevenne (anv)
03257cb8d0 [FIX] odoo_theme: show a cursor when hovering on an image without modal
The images that have the class `o-no-modal` cannot be clicked to open in
a modal, so the cursor should not be changed to a pointer when hovering
on them.

This commit also simplifies the theme's SCSS by replacing the hard-coded
SVG images used in the "Supported versions" page by unicode circles with
a custom styling.

X-original-commit: f648960c78
Part-of: odoo/documentation#2465
Co-authored-by: Elisabeth Dickinson (edi) <edi@odoo.com>
2022-07-13 16:48:23 +02:00
Antoine Vandevenne (anv)
860234a415 [FIX] odoo_theme: only open images that have no target in modal
Since clicking on the image redirects the user to the target URL, it's
useless to open the image in a modal. Also, it partially broke the
layout of the /legal.html page due to the modal div being inserted into
table cells.

This commit also introduces the possibility to add the `o-no-modal`
class on images that should not open in a modal.

task-2909167

X-original-commit: 7cbbb77746
Part-of: odoo/documentation#2465
2022-07-13 16:48:23 +02:00
Antoine Vandevenne (anv)
291a3db45c [IMP] developer/rdtraining: simplify the development environment setup
In an attempt to help new developers install Odoo with a
straightforward procedure, Chapter 2 of the "Getting started" tutorial
included copy-pastes of parts of the "Installing Odoo" page. This proved
to be inefficient because it required maintaining documentation on the
installation procedure in several places and misled the readers by
suggesting installing the Python requirements *after* installing
PostgreSQL.

With this commit, the page on Chapter 2 is refreshed to be clearer to
the readers and redirect them to the "Installing Odoo" page when
necessary.

task-2908434

closes odoo/documentation#2460

X-original-commit: f75cbca98c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-13 16:48:00 +02:00
Antoine Vandevenne (anv)
88fa15e327 [MOV] developer/reference: move up the standard_modules directory
With the renaming of the "Backend" and "Frontend" directories to "Python
framework" and "JavaScript framework", and since we may want to document
modules that mainly rely on JavaScript, it makes sense to move the
"Standard modules" one level up from under "Python framework" directly
under "Reference".

closes odoo/documentation#2457

X-original-commit: 62e80093bd
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-13 16:47:58 +02:00
Antoine Vandevenne (anv)
db835469a1 [IMP] developer: rename reference directories to "Py/Js framework"
It was confusing to label the directory for pages related to the Python
framework "Backend" as, in Odoo, the backend is the web client, and the
frontend is the portal/website. It also led to the "Standard modules"
directory to be placed within the "Backend" directory as of `saas-15.1`
to indicate that they were part of the backend too, but that was a
mistake. Indeed, most standard modules comprise JavaScript methods, and
we could want to document these in the reference at some point.

X-original-commit: 8046f742bc
Part-of: odoo/documentation#2457
2022-07-13 16:47:57 +02:00
Antoine Vandevenne (anv)
625fac0a88 [FIX] odoo_theme: fix the display of modal images in mobile
task-2908330

closes odoo/documentation#2448

X-original-commit: 5e0f14f683
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-12 17:33:37 +02:00
LoredanaLrpz
12541f41ca [ADD] pos: add a doc about tracking numbers in pos
Task ID: 2622088

closes odoo/documentation#2447

X-original-commit: 235d2ad749
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
Co-authored-by: Robin Boisdenghien <robo@odoo.com>
2022-07-12 16:14:35 +02:00
Antoine Vandevenne (anv)
2598fc1012 [CLN] conf.py: stop labelling saas-15.1 in version switcher
The branch was recently dropped from the supported versions. We no
longer need to add a label for it in the version switcher.

closes odoo/documentation#2435

X-original-commit: 2481e3d842
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-11 14:59:59 +02:00
LoredanaLrpz
24b116a23d [IMP] pos: add a warning about Six unusability in July
Task ID:2893426
Since Six payment terminal won't be usable starting in July 2022, I
added this warning.

closes odoo/documentation#2423

X-original-commit: ceec1b0436
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
2022-07-08 10:03:05 +02:00
“Lau-Odoo”
6ec2c5dfeb [IMP] ecommerce: remove one sub-menu to add it as a see also
task - 2904108 I removed the "website/publish" section from the toctree to add a link to the full website documentation inside off the see also.

closes odoo/documentation#2418

X-original-commit: 7307dac6a6
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-07 20:01:28 +02:00
Demesmaeker
5102b8ea1e [FIX] sale_amazon: fix information displayed
Both carrier name and tracking reference are now displayed to the
customer, even when using the carrie `Self Delivery`

task-2900803

closes odoo/documentation#2410

X-original-commit: 471d0c2094
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-07 14:12:56 +02:00
LoredanaLrpz
5db7fd6cd7 [ADD] pos: add a new doc page about sales orders in pos
Task ID: 2622084

closes odoo/documentation#2398

X-original-commit: 53744bea5b
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Co-authored-by: Quentin Celis (qce) <qce@odoo.com>
Co-authored-by: Xavier Plateau (xpl) <xpl@odoo.com>
Co-authored-by: Robin Boisdenghien (robo) <robo@odoo.com>
2022-07-07 07:15:55 +02:00
LoredanaLrpz
81c92f4056 [IMP] pos: change the page heading
closes odoo/documentation#2401

X-original-commit: a5d850e230
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-07-07 06:17:09 +02:00
Ludvig Auvens
1924117ab5 [IMP] eCommerce: update of cross-selling doc for Odoo 15.0 and after.
closes odoo/documentation#2391

X-original-commit: db8b45ead2
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-06 18:16:49 +02:00
Antoine Vandevenne (anv)
f30e84c92a [IMP] developer/javascript: unify the styling of API references
Now that a new styling for API references was added with commit 934f45c,
we can remove the extra CSS that was crafted specifically for JavaScript
API references with commit 05a0a49a. While we're at it, this commit also
applies the new styling to definition lists that were missing it, like
it was done for the page on views with commit 120ae785.

closes odoo/documentation#2376

X-original-commit: 31a9d4a340
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-04 18:11:03 +02:00
Antoine Vandevenne (anv)
12ff9f118b [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#2371

X-original-commit: 109817311e
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-04 16:18:16 +02:00
“Lau-Odoo”
20b12c9958 [IMP] website: broken link removal
task - 2841794

closes odoo/documentation#2363

X-original-commit: c40059e0a7
Signed-off-by: Auvens Ludvig (lau) <lau@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-07-01 13:30:03 +02:00
Tom Aarab (toaa)
4ace49cee6 [IMP] accounting: Adyen's backend changes for the webhook creation
Adyen's backend had slightly changed and the previous doc version was outdated (URL and HMAC key fields)

task - 2810213

closes odoo/documentation#2354

X-original-commit: da87312821
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-07-01 12:29:51 +02:00
Michelle Vu (mivu)
ae744df665 [IMP] discuss: custom ICE server list optional
This will edit the "Define a list of custom ICE servers" section in the
"Configure ICE servers with Twilio" v15.0 user doc. I added a line to
mention that defining a list of custom ICE servers is an optional step,
as Odoo only uses this list as a fallback if Twilio is not configured or
is not working at any given moment.

Fixes PR #1994
Closes Odoo Task 2882679

closes odoo/documentation#2346

X-original-commit: 7f2110e8a3
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-29 12:16:46 +02:00
Antoine Vandevenne (anv)
8aeee6c1c6 [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#2340

X-original-commit: e2a3ca0631
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-29 09:14:52 +02:00
LoredanaLrpz
b65cfc12dd [ADD] pos: adyen payment terminal
Task ID: 2808584
Do not Forward port r+

closes odoo/documentation#2333

X-original-commit: 85b5374995
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Perazzo Loredana (lrpz) <lrpz@odoo.com>
2022-06-28 15:02:04 +02:00
LoredanaLrpz
95c3d0d97c [IMP] pos: change titles
X-original-commit: 5618e5ad9b
Part-of: odoo/documentation#2333
2022-06-28 15:02:04 +02:00
Odoo's Mergebot
6be0446259
[FW][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#2326

Forward-port-of: odoo/documentation#2264
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-28 10:29:03 +02:00
Gopakumar N G
3bd9640881 [FIX] pos: change the tab name in the configuration steps
closes odoo/documentation#2311

X-original-commit: 2f41dc4445
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-27 16:05:58 +02:00
Elisabeth Dickinson
04f5b0a716 [REF] odoo_theme: replace values with variables in SCSS files
X-original-commit: c82d95b17c
2022-06-27 15:42:43 +02:00
Elisabeth Dickinson
5fa54af26d [REF] odoo_theme: move stray mixins into the _mixins.scss file
X-original-commit: 7fa153594d
2022-06-27 15:42:42 +02:00
Elisabeth Dickinson
8ce98f52ec [CLN] odoo_theme: remove unnecessary css
X-original-commit: fca78f44db
2022-06-27 15:42:41 +02:00
Elisabeth Dickinson
cb0e0f2985 [CLN] odoo_theme: remove old doc's unused variables
X-original-commit: 383e3d4206
2022-06-27 15:42:40 +02:00
Elisabeth Dickinson
3bcdd860f0 [REF] odoo_theme: move scrollbar styling to .o_side_nav-inner
X-original-commit: b9ca38215d
2022-06-27 15:42:39 +02:00
Elisabeth Dickinson
42d0b475cc [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.

X-original-commit: 9a2e8eefef
2022-06-27 15:42:38 +02:00
Elisabeth Dickinson
a24594857a [IMP] odoo_theme: replace "hide search matches" by a close button
X-original-commit: 994d273a59
2022-06-27 15:42:37 +02:00
Elisabeth Dickinson
fef1dc3ba5 [IMP] odoo_theme: improve spacing around code blocks on reference pages
X-original-commit: 794e42f78b
2022-06-27 15:42:37 +02:00
Elisabeth Dickinson
f18355c555 [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.

X-original-commit: 0b536debac
2022-06-27 15:42:36 +02:00
Elisabeth Dickinson
235464d0d9 [FIX] odoo_theme: remove the horizontal scroll bar
X-original-commit: 26bc1cd707
2022-06-27 15:42:35 +02:00
Elisabeth Dickinson
51271e432b [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.

X-original-commit: 91cb3ca026
2022-06-27 15:42:34 +02:00
Elisabeth Dickinson
6176718eb0 [IMP] odoo_theme: improve general spacings and paddings
X-original-commit: 2e693b3c4a
2022-06-27 15:42:33 +02:00
Elisabeth Dickinson
fccd6bb800 [IMP] odoo_theme: improve special terms styling
Including the `:command:`, `:file:` and `:dfn:` roles, and code-styled
text in alerts.

task-2790284

X-original-commit: 7239986484
2022-06-27 15:42:32 +02:00
Jonathan Castillo (jcs)
a9e77b310b [IMP] contributing: update the rst cheat sheet
task - 2810468

closes odoo/documentation#2318

X-original-commit: 9ff312298d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Elisabeth Dickinson (edi) <edi@odoo.com>
2022-06-27 15:01:29 +02:00
Valentin Chevalier
2c676ed846 [IMP] developer/howtos: Add missing information about debug mode
In chapter 3 of the developer core training, one is asked to click on a
button that is only shown in debug mode but there is no indication about
this mode in this chapter.

closes odoo/documentation#2302

X-original-commit: 96d822bf87
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-27 09:59:58 +02:00
Donatienne Pirlot
6039ab126c [IMP] accounting: note about outstanding accounts
task-2868642

closes odoo/documentation#2295

X-original-commit: 11f9c35191
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-06-24 17:42:08 +02:00
Antoine Vandevenne (anv)
873dc25718 [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#2289

X-original-commit: f8b03c5554
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-24 10:52:03 +02:00