Commit Graph

206 Commits

Author SHA1 Message Date
Mahmoud Metwally
f7444ef8af [FW][FIX] howtos/company: fix typos
closes odoo/documentation#4173

Forward-port-of: odoo/documentation#4147
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-17 17:50:24 +02:00
Mahmoud Metwally
35582d787a [FW][FIX] developer/web_services: fix typo
closes odoo/documentation#4156

Forward-port-of: odoo/documentation#4146
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-14 11:11:26 +02:00
Benoit Socias
fdd80103ba [IMP] tutorials: add warning about mutable global variables
The whole concept of multi-tenancy is not really approached within the
tutorial.

This commit adds a warning about never using mutable global variables
within odoo to seed the idea in the reader's mind.

task-3059110

closes odoo/documentation#3987

X-original-commit: 1ce7166f49
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Benoit Socias (bso) <bso@odoo.com>
2023-04-03 13:12:24 +02:00
Antoine Vandevenne (anv)
31b7ebbb5f [ADD] extensions/cards: add an extension to implement cards
The extension adds two new directive:
- `cards` is the row container for one or more `card` directives.
- `card` is the implementation of a Bootstrap card that accepts a
  `target` argument for the href of the card, a `large` option to render
  the card on two columns, a `tag` option to display a single arbitrary
  tag on the card, and arbitrary content that is shown in the card
  body.

task-3141419

closes odoo/documentation#3684

X-original-commit: 72e636da5f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-28 11:05:57 +01:00
Antoine Vandevenne (anv)
1b0e778220 [MOV] developer/cli: move "Command-line interface (CLI)" to the reference dir
task-2991663

closes odoo/documentation#3649

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-22 16:28:57 +01:00
Antoine Vandevenne (anv)
4136a71347 [MOV] developer/api/extract_api: move "Extract API" to the reference dir
task-2991663

Part-of: odoo/documentation#3649
2023-02-22 16:28:57 +01:00
Antoine Vandevenne (anv)
e24059f6af [MOV] developer/api/external_api: move "External API" to the reference dir
task-2991663

Part-of: odoo/documentation#3649
2023-02-22 16:28:56 +01:00
Antoine Vandevenne (anv)
354bb2b9d6 [MOV] developer/api/iap: move "In-App Purchase" to the howtos dir
task-2991663

Part-of: odoo/documentation#3649
2023-02-22 16:28:56 +01:00
Antoine Vandevenne (anv)
7e45350d56 [MOV] developer/iot: move "Internet of things" the howtos dir
task-2991663

Part-of: odoo/documentation#3649
2023-02-22 16:28:56 +01:00
Antoine Vandevenne (anv)
409dfed48a [IMP] tutorials/*: hide outdated tutorials
*: backend, web, website

task-2991663

Part-of: odoo/documentation#3649
2023-02-22 16:28:55 +01:00
Antoine Vandevenne (anv)
826c81b862 [MOV] howto/web: move "Customizing the webclient" to the tutorials dir
task-2991663

Part-of: odoo/documentation#3649
2023-02-22 16:28:55 +01:00
Antoine Vandevenne (anv)
023755d5fd [MOV] howto/website: move "Building a website" to the tutorials dir
task-2991663

Part-of: odoo/documentation#3649
2023-02-22 16:28:55 +01:00
Antoine Vandevenne (anv)
1e8450b66f [MOV] howtos/backend: move "Building a module" to the tutorials dir
task-2991663

Part-of: odoo/documentation#3649
2023-02-22 16:28:55 +01:00
Antoine Vandevenne (anv)
daf82ef1db [MOV] tutorials/getting_started/*: promote advanced chapters to independent tutorials
task-2991663

Part-of: odoo/documentation#3649
2023-02-22 16:28:54 +01:00
Antoine Vandevenne (anv)
1e5ab03f6a [MOV] howto/rdtraining: move "Getting started" to the tutorials dir
This commit also replaces references to the "Building a module"
tutorial by references to the "Getting started" tutorial.

task-2991663

Part-of: odoo/documentation#3649
2023-02-22 16:28:54 +01:00
Antoine Vandevenne (anv)
b08d63a4c6 [ADD] developer/tutorials: add a directory for developer tutorials
task-2991663

Part-of: odoo/documentation#3649
2023-02-22 16:28:54 +01:00
Jonathan Castillo (jcs)
cddb38c443 [FIX] *: RST cleanup
RST cleanup to comply with the RST guidelines. This is required so we
can use "make test", as there are currently hundreds of errors. For now,
it is unusable because of the oldest code in this repo.

closes odoo/documentation#3574

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-15 09:35:49 +01:00
Mahmoud Metwally
6a2bdd8abb [FW][FIX] developer/howtos: typos and phrasing
closes odoo/documentation#3554

Forward-port-of: odoo/documentation#3541
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-02-13 14:34:31 +01:00
Mahmoud Metwally
65aca15110 [FW][FIX] developer/javascript_reference: typos and phrasing
closes odoo/documentation#3473

Forward-port-of: odoo/documentation#3470
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-02-02 16:49:39 +01:00
Jonathan Castillo (jcs)
3f8bf2ef9c [IMP] accounting: update how to get api keys for silverfin integration
task 2918697

closes odoo/documentation#3425

X-original-commit: 9a0bf7bb0e
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-27 14:34:40 +01:00
Mathieu (mano)
207b741d23 [IMP] toctrees: redesign and new card component
The goal of this commit is to propose a first step towards a new
`.. card::` directive for the toctrees. This is a first design
proposition for this new card component in raw html for the fallback
page `howtos.rst`

The long term objective is to redesign the toctrees by implementing card
components, clearer toctree list design and custom html pages.

Related to task-3059229

closes odoo/documentation#3405

X-original-commit: 53035435f9
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-26 17:10:47 +01:00
Mahmoud Metwally
f6bb78491b Update qweb.rst
closes odoo/documentation#3286

X-original-commit: 8cde1f7b74
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-04 13:49:42 +01:00
Mahmoud Metwally
55f59daf2b [FIX] rdtraining: fix writing errors
closes odoo/documentation#3258

X-original-commit: ad91dd67c2
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-03 13:11:28 +01:00
Antoine Vandevenne (anv)
b7b36e9ef4 [ADD] contributing/development: add a guide to contribute to the codebase
In addition, this commit extracts the git guidelines from the coding
guidelines. This helps link the git guidelines and unclutter the coding
guidelines, which should focus on only the programming languages.

task-2897123

Part-of: odoo/documentation#3254
2023-01-03 10:19:42 +01:00
Horacio Tellez
6b3a572c65 [FIX] rdtraining: remove outdated line about journal_id in chapter 14
In chapter 14 there was a line pointing to how to deduce a default journal for an `account.move` record.
This is no longer needed as the journal is automatically deduced using the `move_type`. Also, the link
point to an outdated line of code that causes an error.

closes odoo/documentation#3180

X-original-commit: 67a75a3e11
Signed-off-by: Horacio Tellez Perez (hote) <hote@odoo.com>
2022-12-12 09:24:58 +01:00
Antoine Vandevenne (anv)
0a272f64ce [IMP] conf.py, *: interpolate the version and releases in the content
This commit replaces hard-coded occurrences of the version and of the
last, current and next releases' version with placeholders interpolated
at build time to avoid manually updating these after each freeze.

task-2917614

closes odoo/documentation#3149

X-original-commit: 359ab4d028
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-08 13:55:59 +01:00
Ivan Kropotkin
3f98f4bebd [FW][FIX] developer/reference: code example
closes odoo/documentation#3025

Forward-port-of: odoo/documentation#2943
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-24 18:01:07 +01:00
Victor Feyens
b6c338a1a5 [IMP] developer/howtos: deprecate themes tutorial
This tutorial was already outdated in 13.0 (but
supposedly working).

In 14.0+, a lot of changes happened in website logic,
especially for 'website option definitions', breaking
the existing theme tutorial.

Considering the fact that a new tutorial is being made,
and that fixing the whole existing tutorial would be
a big work, it will be kept, but hidden as 'most things
being said still make sense'.

closes odoo/documentation#3003

X-original-commit: 9cc60baf46
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-21 18:30:48 +01:00
Victor Feyens
252161b161 [FIX] developer/mobile: use spaces and not tabs for indentation
closes odoo/documentation#2981

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-18 17:42:19 +01:00
Victor Feyens
749d99b7c5 [FIX] *: unbalanced literal markups
Part-of: odoo/documentation#2981
2022-11-18 17:42:18 +01:00
Victor Feyens
b8ef59ef84 [FIX] *: remove trailing whitespaces
Part-of: odoo/documentation#2981
2022-11-18 17:42:18 +01:00
Victor Feyens
d2c190f11e [FIX] *: enforce 1 newline on files end
Part-of: odoo/documentation#2981
2022-11-18 17:42:18 +01:00
Victor Feyens
c3d8cb2fdb [CLN] core: upgrade to python 3.6
& sort imports

closes odoo/documentation#2960

X-original-commit: 5128208495
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-17 09:41:55 +01:00
Victor Feyens
add6751897 [FIX] developer/guidelines: do not mention deprecated xml tags
act_window & report xml tags have been deprecated by
6835aeb0de
two years ago, we should avoid mentioning them in the guidelines.

Furthermore, in 17.0 they won't be available anymore.

closes odoo/documentation#2859

X-original-commit: 758463edd4
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-25 18:53:47 +02:00
Jonathan Castillo (jcs)
c37f31b59a [IMP] *: Remove "SaaS" to keep only the "Odoo Online" appellation
task-3034812

closes odoo/documentation#2834

X-original-commit: eae71e6eda
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-10-21 15:27:35 +02:00
Elias
43ced953ed [FIX] developer/howtos/rdtraining: Update warning message
Update warning output for missing access rules.
Also reflect up-to-date contents of res.country.state.csv.

closes odoo/documentation#2823

X-original-commit: e21dbd01c9
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-18 12:58:48 +02:00
Xavier-Do
21a914e777 [ADD] developer/reference: add a reference page on performance
closes odoo/documentation#2791

X-original-commit: 4d8e3f9785
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Xavier Dollé (xdo) <xdo@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-06 13:21:03 +02:00
Aleksander
168b5956c0 [FW][IMP] howtos/rdtraining: give the meaning of "ACL"
closes odoo/documentation#2776

Forward-port-of: odoo/documentation#2774
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-30 13:21:45 +02:00
Claire Bretton (clbr)
ef06d3828d [IMP] developer/howtos/rdtraining: Add missing information about module category.
Adds explanations and directive for module category creation, so it can be used correctly at res.groups creation.

closes odoo/documentation#2727

X-original-commit: 338fe297b0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-16 16:38:50 +02:00
Max
093db643bb [FW][IMP] developer/backend: correct filters attribute for calendar view fields
closes odoo/documentation#2722

Forward-port-of: odoo/documentation#2692
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-09-15 17:09:45 +02:00
Julien Castiaux
15bb7cb26b [IMP] developer/api/external_api: XML-RPC in PHP8
Starting PHP8, the XML-RPC extension is not available by default
anymore and must be installed separately.

closes odoo/documentation#2717

Task: 2613818
X-original-commit: 79e58e3db1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-14 15:19:39 +02:00
Julien Castiaux
4f66b8f424 [IMP] content/developer/webservices
It is hard to find and learn about RPC in Odoo, users hardly know about
JSON-RPC as the only place where we talk about it in deep down in the
*How to make a Module* tutorial.

In the commit, we isolated the tutorial about RPC in a dedicated file,
that file is better referenced thanks to cross-references in some others
places that are talking about RPC

Task: 2884559
X-original-commit: 83c2e6de0b
Part-of: odoo/documentation#2717
2022-09-14 15:19:38 +02:00
std-odoo
0caeb7a17e [IMP] mail: add documentation about the SSL SMTP authentication
Purpose
=======
Add the documentation about the SSL SMTP authentication
(2 new binary arguments) and also about the new from
filter binary argument.

The goal of those new arguments is to improve the score
of the emails sent by Odoo.

Task 2367946
See odoo/odoo/pull/61853
See odoo/upgrade/pull/1903

closes odoo/documentation#2704

X-original-commit: 2a01b21800
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-09-12 16:06:57 +02:00
poma-odoo
b2944abc70 [FW][FIX] developer/frontend: small typos
closes odoo/documentation#2606

Forward-port-of: odoo/documentation#2584
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-08-18 18:45:57 +02:00
Antoine Vandevenne (anv)
5a7d700817 [IMP] rdtraining: mention that the second part needs to be completed too
closes odoo/documentation#2538

X-original-commit: 9279fb80a7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-08-01 17:56:32 +02:00
Victor Feyens
35fc905905 [CLN] rdtraining: remove reference to unexisting file
The referenced `bypass.py` file isn't specified anywhere in
the training documentation or code content.

The paragraph is removed to avoid meaningless searches and
confusing trainees.

This commit also adds a missing parenthese in the preceding
code content.

Fixes #2488

closes odoo/documentation#2520

X-original-commit: 1c4abe4e07
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-25 13:31:47 +02:00
Benoit Socias
35c5d6f098 [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#2509

X-original-commit: b8ee134a28
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-20 13:55:46 +02:00
Victor Feyens
b8a857b8eb [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#2482

X-original-commit: 60adfacbc9
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-14 20:32:20 +02:00
Antoine Vandevenne (anv)
b2c9765705 [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#2456

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-13 16:46:24 +02:00
Antoine Vandevenne (anv)
7eed1ddc5d [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: bdafd7c
Part-of: odoo/documentation#2456
2022-07-13 16:46:24 +02:00