Commit Graph

238 Commits

Author SHA1 Message Date
luvi
7a9d807bcc [ADD] web: add core components documentation
Those components were added during the Owl rewrite of the webclient
that happened in 16.0. Unfortunately, there was still no documentation
for them.

This commits fixes that by adding documentation for the Notebook and
the Colorlist components.

closes odoo/documentation#3580

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-15 13:52:53 +01:00
Jonathan Castillo (jcs)
17319f92b2 [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#3581

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-15 12:51:21 +01:00
Amelia Williams
18b000602b [FIX] 02_setup: remove gramatical error
closes odoo/documentation#3579

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-15 11:46:43 +01:00
Mahmoud Metwally
7913fd7bdd [FW][FIX] developer/howtos: typos and phrasing
closes odoo/documentation#3555

Forward-port-of: odoo/documentation#3541
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-02-13 14:53:07 +01:00
luvi
fc79df42fd [FIX] web: fix wrong ActionSwiper documentation
Since 16.0, the documentation for this component was no longer
correct, since the component was moved to web during the refactor
of the webclient views. This commit also adds documentation of
props that were introduced during the refactor, already present
in 16.0.

closes odoo/documentation#3504

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-08 15:24:35 +01:00
Mahmoud Metwally
e6269ae56e [FW][FIX] developer/javascript_reference: typos and phrasing
closes odoo/documentation#3474

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

closes odoo/documentation#3426

X-original-commit: 9a0bf7bb0e
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-27 14:37:57 +01:00
Mathieu (mano)
620387b9e8 [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#3406

X-original-commit: 53035435f9
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-26 18:14:09 +01:00
fdardenne
a70665ef34 [FIX] developer: remove merge text in chapter 6
closes odoo/documentation#3348

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-18 11:49:18 +01:00
Xavier BOL (xbo)
f51633fdd5 [IMP] backend: add groups_draggable option in kanban view
Related PR: odoo/odoo#97447

task-2941335

closes odoo/documentation#3312

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-16 10:03:46 +01:00
stefanorigano (SRI)
2ca32b40bc [IMP] scss: update, improve preexisting content
Add a new content focused on SCSS and user-interface.

- SCSS coding guidelines: regroup information already available (eg [1])
  or based on "oral tradition".
  The aim is not to establish new rules, ~99% of the current codebase
  is already compliant.

- SCSS inheritance: explain how SCSS assets management works in odoo.
  For example, people still find confusing that overrides are defined
  *before* the variable to customize.

- SCSS optimization tips: suggestions to lean SCSS code. Based on SCSS
  optimization task's know-how [2].

- CSS variables: explain how this feature is commonly used in odoo to
  adapt layout & design without raw CSS overrides.

- UI Icons: Add link to fontAwesome4 library . Replace the picture of
  odoo icons with the actual font (90kb image VS 15Kb font)

[1] https://github.com/odoo/odoo/wiki/SCSS-coding-guidelines
[2] https://www.odoo.com/web#id=2704984&menu_id=4720&cids=1&model=project.task&view_type=form

task-3090800

closes odoo/documentation#3093

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-12 18:19:27 +01:00
fdardenne
54628b4f5b [IMP] developer: JavaScript tutorial: chapter 3-7
This commit adds the chapter 3,4,5,6 and 7 of the JavaScript web
framework tutorial.

This new tutorial allows people to discover Owl and the building blocks
of the Odoo JavaScript framework.

closes odoo/documentation#3222

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Géry Debongnie <ged@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-12 16:00:50 +01:00
Mahmoud Metwally
9705552a6b Update qweb.rst
closes odoo/documentation#3288

X-original-commit: 8cde1f7b74
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-04 15:10:00 +01:00
Mahmoud Metwally
9c9c20110c [FIX] rdtraining: fix writing errors
closes odoo/documentation#3266

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-03 19:07:18 +01:00
Antoine Vandevenne (anv)
8d94f66d81 [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#3260
2023-01-03 13:27:05 +01:00
oco-odoo
bf2d3d9ed2 [IMP] accounting: full documentation of the new report engine
Engine report for accounting.

closes odoo/documentation#2784

Taskid: 3042880
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-12-21 16:55:24 +01:00
fdardenne
1bd7e803e0 [IMP] developer: JavaScript tutorial: enhance chapter 1
This commit adds several small information on chapter 1 of the training
 owl:

- 1.1 How to get to the playground controller
- 1.2 Add a reference on sub component
- 1.4 How to activate the dev mode in owl

closes odoo/documentation#3177

Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
2022-12-14 17:56:07 +01:00
Horacio Tellez
924e6a2339 [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#3182

X-original-commit: 67a75a3e11
Signed-off-by: Horacio Tellez Perez (hote) <hote@odoo.com>
2022-12-12 09:55:44 +01:00
Valentin Vallaeys (vava)
b2d0ab29a5 [FIX] developer: better definition for oe_inline
closes odoo/documentation#3171

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-09 15:19:04 +01:00
Antoine Vandevenne (anv)
fa2d0f6363 [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#3166

X-original-commit: 12e1085199
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-09 10:40:06 +01:00
fdardenne
c5c6daef22 [IMP] developer: JavaScript tutorial: chapter 2
This commit adds the chapter 2 of the JavaScript tutorial.

This new tutorial allows people to discover Owl and the building blocks
of the Odoo JavaScript framework.

closes odoo/documentation#3105

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Géry Debongnie <ged@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-08 16:43:13 +01:00
fdardenne
62051b643f [ADD] developer: add a tutorial on Owl
This commit adds the introduction and the chapter 1 of the new
Owl/JavaScript framework tutorial.

This new tutorial allows people to discover Owl and the building blocks
of the Odoo JavaScript framework.

closes odoo/documentation#2845

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Géry Debongnie <ged@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-01 18:04:17 +01:00
Ivan Kropotkin
17bb126cab [FW][FIX] developer/reference: code example
closes odoo/documentation#3027

Forward-port-of: odoo/documentation#2943
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-25 03:52:51 +01:00
Victor Feyens
b2121b7891 [FIX] developer/*: code blocks linting & fixes
invalid xml
invalid python
correct indentation

closes odoo/documentation#3001

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-24 21:38:37 +01:00
Victor Feyens
387cf15e7f [FIX] developer/*: consistent code-block language specification
Part-of: odoo/documentation#3001
2022-11-24 21:38:37 +01:00
Jeff Nyalik
e44a8c49bb [FIX] rdtraining: fix typo
Kind of a typo here " it will not possible" to "it will not be possible"

closes odoo/documentation#3016

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-23 18:39:58 +01:00
william-andre
025e365a9b [IMP] cli: suggest auto complete script
Add a hint to how to build autocompletion values for odoo-bin

closes odoo/documentation#3008

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-22 16:13:38 +01:00
Victor Feyens
e9c26512e6 [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#3005

X-original-commit: 9cc60baf46
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-21 20:12:45 +01:00
Victor Feyens
568e8a28fa [FIX] developer/mobile: use spaces and not tabs for indentation
closes odoo/documentation#2983

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-18 20:30:01 +01:00
Victor Feyens
1b811f8de8 [FIX] *: unbalanced literal markups
Part-of: odoo/documentation#2983
2022-11-18 20:30:01 +01:00
Victor Feyens
c367974170 [FIX] *: remove trailing whitespaces
Part-of: odoo/documentation#2983
2022-11-18 20:30:01 +01:00
Victor Feyens
968ed0a17a [FIX] *: enforce 1 newline on files end
Part-of: odoo/documentation#2983
2022-11-18 20:30:00 +01:00
Victor Feyens
31f9b8a56d [CLN] core: upgrade to python 3.6
& sort imports

closes odoo/documentation#2975

X-original-commit: 57784a2f90
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-17 17:20:55 +01:00
Chong Wang (cwg)
f2fd03b8fc [IMP] orm/changelog: store translations in jsonb
closes odoo/documentation#2801

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-11-03 14:42:10 +01:00
Victor Feyens
c8ab8908da [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#2861

X-original-commit: 758463edd4
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-25 18:59:54 +02:00
Victor Feyens
1225c93112 [FIX] developer/cli: remove unsupported cli options
Removed by c0647b5c52

Fixes odoo/odoo#104060

closes odoo/documentation#2856

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-25 18:59:51 +02:00
niyasraphy
3f34c3874c [IMP] report_barcode function: parameter type to barcode_type
ee324e8374

closes odoo/documentation#2843

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-24 16:52:54 +02:00
Jonathan Castillo (jcs)
9b69e0d77e [IMP] *: Remove "SaaS" to keep only the "Odoo Online" appellation
task-3034812

closes odoo/documentation#2836

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-10-21 16:19:58 +02:00
Elias
90513b30dc [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#2825

X-original-commit: e21dbd01c9
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-18 12:53:39 +02:00
Victor Feyens
93b383e95d [FIX] *: Odoo 16 requires postgresql 12
Update the minimal version in the installation doc
Make all postgresql docs references target the v12 documentation
Fix some non http links on the way

closes odoo/documentation#2821

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-17 23:02:34 +02:00
Victor Feyens
7c42ab8eaf [IMP] developer/orm: environment documentation
Move Environment explanation to the class docstring and autogenerate the
doc

Add documentation on some util methods.

closes odoo/documentation#2798

Related: odoo/odoo#102896
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-10 18:03:50 +02:00
Victor Feyens
b7f5b3e04b [FIX] developer/iap: wrong :class: element
Part-of: odoo/documentation#2798
2022-10-10 18:03:49 +02:00
Antoine Vandevenne (anv)
7696235acb [IMP] reference/payment: auto-document the method _get_removal_values
Task - 3002532

closes odoo/documentation#2799

Related: odoo/odoo#102265
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-10 17:00:20 +02:00
Antoine Vandevenne (anv)
668ac2c650 [ADD] reference/standard_modules: API reference for the payment engine
task-2804999

closes odoo/documentation#2782

Related: odoo/odoo#101756
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-07 20:12:06 +02:00
Xavier-Do
811510fbcb [ADD] developer/reference: add a reference page on performance
closes odoo/documentation#2793

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:13:02 +02:00
Denis Ledoux
0bdf714112 [IMP] developer/reference: move model view related methods out of orm
The model method `get_views` and `get_view` are moved
from `odoo/models.py` to `odoo/addons/base/models/ir_ui_view.py`.

The documentation is updated accordingly,
to put the documentation related to `get_views` in the
views chapter of the documentation.

closes odoo/documentation#2760

Related: odoo/odoo#101200
Signed-off-by: Denis Ledoux (dle) <dle@odoo.com>
2022-10-04 15:18:03 +02:00
Aleksander
508b089f68 [FW][IMP] howtos/rdtraining: give the meaning of "ACL"
closes odoo/documentation#2778

Forward-port-of: odoo/documentation#2774
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-01 15:11:40 +02:00
Victor Feyens
c765ea9bad [REL] freeze 16.0 branch 2022-09-21 08:45:37 +02:00
Claire Bretton (clbr)
33196968df [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#2729

X-original-commit: 338fe297b0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-16 23:49:41 +02:00
Prakash Prajapati
8e4dedc9a1 [ADD] web_gantt: add pill_label attribute in gantt_view
task-2672783

closes odoo/documentation#2649

Related: odoo/enterprise#28372
Signed-off-by: Laurent Stukkens (ltu) <ltu@odoo.com>
2022-09-16 14:24:59 +02:00