Commit Graph

163 Commits

Author SHA1 Message Date
Artygo8
07eef81a95 [IMP] reference/extract: update documentation
task-3071317

closes odoo/documentation#3835

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-04-21 14:15:46 +02:00
Tiffany Chang (tic)
e2c880aafe [REM] developer: remove references to web_dashboard view
Since odoo/enterprise#31641 the dashboard view no longer exists since it
is now replaced with spreadsheet_dashboard, therefore we remove it from
the backend Views documentation.

Task: 3226581
Part-of: odoo/documentation#4031
2023-04-05 14:47:46 +02:00
fdardenne
7e4435deb8 [IMP] create JavaScript howtos
The JavaScript cheatsheet is outdated, we therefore remove it and
replace it by multiple howtos:

- Create a view from scratch
- Extending an existing view
- Create a field from scratch
- Extend an existing field
- Create a client action

There is other subjects to introduce as the web framework is big. Other
future contributions will cover them.

closes odoo/documentation#3969

Signed-off-by: Dardenne Florent (dafl) <dafl@odoo.com>
2023-04-04 16:06:19 +02:00
Antoine Vandevenne (anv)
3dc6bb83c1 [MOV] developer/cli: move "Command-line interface (CLI)" to the reference dir
task-2991663

closes odoo/documentation#3655

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-23 14:33:17 +01:00
Antoine Vandevenne (anv)
73f976e679 [MOV] developer/api/extract_api: move "Extract API" to the reference dir
task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:17 +01:00
Antoine Vandevenne (anv)
95ed856446 [MOV] developer/api/external_api: move "External API" to the reference dir
task-2991663

Part-of: odoo/documentation#3655
2023-02-23 14:33:17 +01:00
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
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
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
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
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
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
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
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
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
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
Victor Feyens
c765ea9bad [REL] freeze 16.0 branch 2022-09-21 08:45:37 +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
Max
c260ecd39d [FW][IMP] developer/backend: correct filters attribute for calendar view fields
closes odoo/documentation#2724

Forward-port-of: odoo/documentation#2692
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-09-15 19:21:33 +02:00
John Laterre (jol)
1b8754a67a [IMP] account_reports: create abstract model for custom reports
closes odoo/documentation#2673

Related: odoo/odoo#98973
Related: odoo/enterprise#30777
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-09-09 12:16:55 +02:00
Julien Alardot (jual)
642968bfd8 [IMP] account, account_report, l10n_*: Introduce unified reporting engine
This commit adapts account's model to the new report engine introduced for v16, and updates the data files accordingly.

account.report model is now declared in community, together with the other models used by the reporting. This is done so that the tax tags can properly be created by the tax report and used on tax templates. All the actual computation logic stays in enterprise.

See enterprise commit for full details.

Task 2524389

closes odoo/documentation#2557

Related: odoo/odoo#94125
Related: odoo/enterprise#28648
Related: odoo/upgrade#3695
Signed-off-by: Julien Alardot (jual) <jual@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-08-25 19:57:06 +02:00
Laurent Stukkens (LTU)
667da8bcff [IMP] developer: add default_period multi values support
Update the documentation accordingly to the support of multi values support
in the default_period attribute of the filter elements in the search views.

task-2941625

closes odoo/documentation#2551

Related: odoo/odoo#97321
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-08-22 18:03:16 +02:00
Antoine Guenet
390126a28a [ADD] frontend: documentation for the editor's Powerbox
This adds a simple documentation for the editor's Powerbox and creates
the base for the editor's own documentation in general.

closes odoo/documentation#2586

Signed-off-by: Antoine Guenet (age) <age@odoo.com>
2022-08-19 11:52:46 +02:00
poma-odoo
ab03f8a9f3 [FW][FIX] developer/frontend: small typos
closes odoo/documentation#2610

Forward-port-of: odoo/documentation#2584
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-08-18 18:25:46 +02:00
Xavier Morel
825048b2be [IMP] backend: clarify and improve steps doc
Current documentation is quite incomplete and not really sufficient to
write up a tour without looking at existing examples.

Try to better document the various options, and the relation between
`trigger`, `extra_trigger` (underscore, not dash), and `run`.

Also add the missing `content` and `timeout` step attributes.

closes odoo/documentation#2550

Related: odoo/odoo#96517
Related: odoo/enterprise#29824
Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com>
2022-08-04 09:13:59 +02:00
Antoine Vandevenne (anv)
f12d8cecbb [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#2459

X-original-commit: 62e80093bd
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-13 19:55:51 +02:00
Antoine Vandevenne (anv)
18efd44da0 [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#2459
2022-07-13 19:55:51 +02:00
aliya
d136ce28ce [IMP] account: refactor account types
See
odoo/odoo#93212
odoo/enterprise#28205

closes odoo/documentation#2223

Related: odoo/upgrade#3595
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-08 19:52:12 +02:00
Antoine Vandevenne (anv)
5244bd6e23 [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#2378

X-original-commit: 31a9d4a340
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-04 17:47:40 +02:00
Antoine Vandevenne (anv)
c24673d532 [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#2342

X-original-commit: e2a3ca0631
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-29 11:11:49 +02:00
Xavier-Do
e9a724958c [IMP] tests: add an option to watch chrome
closes odoo/documentation#2305

Related: odoo/odoo#66769
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-27 15:11:03 +02:00
Gorash
7c4656f0c4 [IMP] qweb: document 't-cache' and 't-nocache' directives
related with: https://github.com/odoo/odoo/pull/88276

closes odoo/documentation#2056

Related: odoo/enterprise#27582
Related: odoo/upgrade#3451
Related: odoo/odoo#88276
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-03 16:40:21 +02:00
Raphael Collet
3da237343f [IMP] developer: new API for flush() and invalidate()
closes odoo/documentation#1909

Signed-off-by: Raphael Collet <rco@odoo.com>
2022-05-25 21:34:53 +02:00