Commit Graph

114 Commits

Author SHA1 Message Date
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
Antoine Vandevenne (anv)
4887907ef7 [MOV] developer/api/odoo: rename odoo.rst into external_api.rst
The previous file name was not very relevant in regard to the content of
the page, and it conflicted with the `sys.path`.

closes odoo/documentation#2068

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-20 14:18:54 +02:00
Antoine Vandevenne (anv)
8722ea902e [MOV] content/*: move resource files into their related page's directory
Since odoo/documentation#903, the guideline for the location of new
resource (images, downloadable files, RST includes...) files is to place
those inside the directory of the RST page that references them.

For example, if `doc1.rst` has a reference to `image.png` and to
`download.zip`, the file structure should look like this:

├── parent_doc/
│     └── doc1/
│     │     └── image.png
│     │     └── download.zip
│     └── doc1.rst
│     └── doc2.rst
├── parent_doc.rst

Before this commit, most of the resource files were still located inside
'media' directories holding all the resource files referenced by RST
pages located at the same level as these directories. In the example
above, a single 'media' directory would hold all the resource files
referenced by both `doc1.rst` and `doc2.rst`. Doing so prevented us from
figuring out easily which resource file was referenced by which RST page
and, thus, lead to unused resource files piling up in the repository. It
also made it more complicated to define codeowners regex rules because a
team could not simply be assigned to `/some_page.*` but needed to be
assigned to both `/some_page\.rst` and to the location of 'media'.

In order to help new content writers figure out the guideline when
taking examples from other RST pages, this commit retroactively applies
the guideline to existing resource files and 'media' directories. The
left-over resource files that are not referenced by any RST page are
removed.

task-2497965

Part-of: odoo/documentation#2068
2022-05-20 14:18:54 +02:00
Beshoy Nabeih
d5d232bb50 [FIX] developer/frontend: typo in the user menu registry example
closes odoo/documentation#2039

X-original-commit: 6d30d81a76
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 18:06:18 +02:00
John Kirkwood (kij)
ded1e69553 [IMP] developer: clarify options for many2one widget
Only `no_create` is required to hide both the 'Create "xxx"' and the
'Create and Edit...' dropdown menu options.

closes odoo/documentation#2016

X-original-commit: 599a137ffc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-18 16:05:03 +02:00
wan
889c9cf0f9 [REF] i18n/localization.rst: rework the entire localization tutorial
closes odoo/documentation#1969

X-original-commit: 9db567159d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: William André (wan) <wan@odoo.com>
Co-authored-by: William Andre <wan@odoo.com>
Co-authored-by: Ivan Yelizariev <iel@odoo.com>
2022-05-09 14:03:24 +02:00
Victor Feyens
9a5c4e5a40 [FIX] developer/orm: fields_view_get is now deprecated
Since odoo/odoo#87522, the method fields_view_get is deprecated and
get_view should be used instead.
A deprecation notice will be included in fields_view_get docstring
to make sure users are aware that they shouldn't use it anymore.

closes odoo/documentation#1908

Related: odoo/odoo#90634
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-05-05 18:47:58 +02:00
Dossogne Bertrand
9e71bb2a7b [FIX] developer: fix duplicate action availability
The duplicate action is not available for list views

closes odoo/documentation#1860

X-original-commit: ce1961ebaf
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-25 10:27:57 +02:00
Dossogne Bertrand
78f66a5298 [FIX] developer: fix duplicate availability
The duplicate action is not available for list views

closes odoo/documentation#1853

X-original-commit: 9cf425d886
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-22 18:09:05 +02:00
poma-odoo
4eb09d95f2 [IMP] developer/views: add and remove tags for position=attributes
The tags`add`, `remove` and `separator` are not included in the
documentation.

closes odoo/documentation#1741

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-29 11:59:50 +02:00
Bruno Boi
0c0a7086ac [IMP] hooks: usePosition new API
closes odoo/documentation#1598

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-21 10:15:16 +01:00
Antoine Vandevenne (anv)
4721c7291f [IMP] developer/api/odoo: rework page to use examples and content tabs
task-2787415

X-original-commit: 1afdec3784
Part-of: odoo/documentation#1692
2022-03-11 14:44:46 +00:00
nle-odoo
8036fd51b5 [FIX] developer/mixins: mail.thread method names
In d46e358d3e88aea9f9289c4845c6c87ab9491c55 some mail.thread method
names were changed: it should be changed in documentation too.

closes odoo/documentation#1686

X-original-commit: b24560e224
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-10 14:59:46 +00:00
Laurent Stukkens
ee52601986 [ADD] developper: add gantt dependency fields
task-2691454

closes odoo/documentation#1529

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-03-03 11:35:42 +00:00
Victor Feyens
d4367c4d9a [FIX] developer/http: adapt to recent httppocalypse changes
See https://github.com/odoo/odoo/pull/78857

closes odoo/documentation#1640

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-02-28 15:25:48 +00:00
Vincent Schippefilt
b49da1df09 [ADD] orm/changelog: Add a changelog page for the ORM changes
Introduce changelog of the ORM by version, link to first change documented

closes odoo/documentation#1508

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-21 16:27:59 +00:00
Mathieu Duckerts-Antoine
9f179bd49d [IMP] hooks: useAutofocus new API
Recently, the API of useAutofocus has been simplified (see 4308de6aab).
Here we adapt its documentation.

closes odoo/documentation#1572

Signed-off-by: Mathieu Duckerts-Antoine <dam@odoo.com>
2022-02-11 16:06:42 +00:00
Mathieu Duckerts-Antoine
2269ee51e8 [REF] notifications: removal of param messageIsHtml
closes odoo/documentation#1557

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-02-10 13:22:39 +00:00
Mathieu Duckerts-Antoine
484d245556 [IMP] hooks: document useAutofocus
Part-of: odoo/documentation#1557
2022-02-10 13:22:38 +00:00
Antoine Vandevenne (anv)
6172c98159 [ADD] developer/reference/frontend: add an icons library page
task-2704984

closes odoo/documentation#1462

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-08 14:26:42 +00:00
Demesmaeker
8966e001c2 [IMP] integration_testing: add information about JS touring
Adding basic information about `How to make a test tour`.

task-2742841

closes odoo/documentation#1524

X-original-commit: dbd5a1e1bb
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 15:55:41 +00:00
Niranjan Abhyankar
ce9cc2f48b [FIX] developer/javascript_cheatsheet: fix a typo
closes odoo/documentation#1521

X-original-commit: d9e2ab6feb
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 13:46:10 +00:00
Antoine Vandevenne (anv)
e4c963d7b6 [FIX] orm: remove autoattribute directive for BaseModel._sequence
The attribute was dropped with PR odoo/odoo#82727

closes odoo/documentation#1522

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 13:27:38 +00:00
wan
0222285869 [ADD] extensions: add a custom example admonition
closes odoo/documentation#1506

X-original-commit: 434bb66492
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-28 11:20:03 +00:00
Stan
194f215662 [IMP] qweb: mention the two possible syntaxes for t-attf
closes odoo/documentation#1467

X-original-commit: cdb8d51131
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-12 09:56:04 +00:00
luvi
331b7b6285 [ADD] developer: actionswiper doc added
This commit adds the developer documentation for a
component recently added to the web_enterprise module.
It also includes examples and a screenshot used in the
documentation.

closes odoo/documentation#1432

X-original-commit: 7763c22db4
Signed-off-by: Géry Debongnie <ged@odoo.com>
Signed-off-by: Luca Vitali <luvi@odoo.com>
2021-12-21 07:42:52 +00:00
Julien Castiaux
e410776f24 [FIX] developer/reference/javascript_reference
The "qweb key of the manifest" file was still mentionned even if it has
been replaced by the assets bundles.

See related task: 2352566

closes odoo/documentation#1434

X-original-commit: dc832e1cc8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-17 11:37:39 +00:00
Jairo Llopis
4dc1223caf [IMP] developer/modules: deprecate 'active' and detail 'auto_install'
1. `active` is just a deprecated field that means exactly the same as
   `auto_install`.
2. `auto_install` can be a list.

See 6cb3140ea8/odoo/modules/module.py (L348-L352)

Original PR: https://github.com/odoo/documentation/pull/1109

closes odoo/documentation#1431

X-original-commit: 53cb375406
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 11:00:04 +00:00
Antoine Vandevenne (anv)
915f1805fd [IMP] developer/*: replace occurrences of "access rule" by "record rule"
Both the functional and technical name of the `ir.rule` model is "Record
Rule". This commit makes sure that all occurrences of "Access Rule" are
replaced by the correct name "Record Rule" as it was easily confused
with "Access Rights".

Original PR: https://github.com/odoo/documentation/pull/1118

closes odoo/documentation#1424

X-original-commit: a692dbdc9c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 09:27:29 +00:00
FrancoisGe
4335271352 [IMP] web: add tooltip on Dropdown
This commit adds the possibility to add a tooltip on a Dropdown.

closes odoo/documentation#1396

Signed-off-by: FrancoisGe <fge@odoo.com>
2021-12-15 08:12:01 +00:00
Samuel Degueldre
888fbb5c50 [IMP] web: adapt documentation to the removal of dropdown-item-selected
closes odoo/documentation#1404

Signed-off-by: Samuel Degueldre <sad@odoo.com>
2021-12-14 14:25:24 +00:00
Tymoteusz Motylewski
dccdca0f41 [IMP] backend/testing: add link to unittest python library
closes odoo/documentation#1416

X-original-commit: a8fe35665b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-14 13:07:05 +00:00
Xavier Morel
90546aa2cd [FIX] orm: documentation of the reserved fields
- reset the `currentmodule` so the fields are not attributed to
  `odoo.fields`, also prefix the field names (for a similar reason)
- expand `active` with the documentation of the related methods

closes odoo/documentation#1352

Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com>
2021-12-10 08:12:53 +00:00
Xavier Morel
55c0c63835 [IMP] orm: TransientModel autodocumentation
* remove the documentation for `_auto`, `abstract`, and `_transient`
  as that's redundant with `Model`
* add documentation for transients' dedicated attributes (and main
  method whose docstring explains what actually occurs)

Part-of: odoo/documentation#1352
2021-12-10 08:12:53 +00:00
Géry Debongnie
4233250b82 [IMP] developer: small rework of assets page (frontend)
This commit applies some remarks by Antoine.

closes odoo/documentation#1328

X-original-commit: 8c1003e363
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-19 13:35:18 +00:00
Bruno Boi
2d93b03dd0 [FIX] developer: effect service
closes odoo/documentation#1325

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-11-19 13:32:47 +00:00
luvi
24d0a9f71d [ADD] developer: scroller service added
This commit adds the documentation related to
the scroller service. This service is used for
the webclient to handle clicks on links and there
were no documentation related until now.

closes odoo/documentation#1326

X-original-commit: 1f84bab97d
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-19 12:36:54 +00:00
Géry Debongnie
eb9cd7558c [IMP] developer: list content of browser object (js)
closes odoo/documentation#1312

X-original-commit: d761910466
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-15 09:39:13 +00:00
Bruno Boi
d015bc03fa [IMP] developer: more info for usePosition JS hook
closes odoo/documentation#1309

X-original-commit: 43d838d826
Signed-off-by: Bruno Boi <boi@odoo.com>
2021-11-12 08:56:14 +00:00
Simon Genin (ges)
172c4490ef [ADD] developer: add js http service
closes odoo/documentation#1306

X-original-commit: bbc85e148e
Signed-off-by: Simon Genin (ges@odoo) <ges@odoo.com>
2021-11-09 18:20:14 +00:00
Géry Debongnie
81261e3c9d [IMP] developer: document formatters/parsers registries
and add entry for effects registry as well

closes odoo/documentation#1303

X-original-commit: 624131f712
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-08 16:22:51 +00:00
Géry Debongnie
7b4879a06c [IMP] developer: rewrite the page on assets
closes odoo/documentation#1302

X-original-commit: 8c79319011
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-08 16:22:48 +00:00
Géry Debongnie
3dd71a4817 [IMP] developer: add section on router service
closes odoo/documentation#1298

X-original-commit: 11171da6b1
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-05 14:23:57 +00:00
Géry Debongnie
a826ed027d [IMP] developer: add missing links in js doc
and slightly improve effect registry page

closes odoo/documentation#1297

X-original-commit: d551193391
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-05 10:29:17 +00:00
Raf Geens
8db85a0caa [FIX] testing: Explain "new" tagging syntax
Syntax was added to explicitly specify a module, class or function with
`--test-tags`: b729a11a12

The documentation was not updated to reflect this, leading to confusion
as people tried to reconcile the documentation with the actual behavior,
without necessarily having seen `odoo-bin --help` which is explicit
about it.

closes odoo/documentation#1282

X-original-commit: 77dd769b08
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Raf Geens <raf@odoo.com>
2021-11-05 08:57:39 +00:00
Géry Debongnie
d16c2472f5 [IMP] developer: normalize reference in js doc
The preferred format for (frontend) references is now:
"frontend/filename/section", or something close to that.

closes odoo/documentation#1294

X-original-commit: 894165a949
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-04 13:51:11 +00:00
Michael (mcm)
3af790ba8e [IMP] developer: add doc for pager and usePager
closes odoo/documentation#1238

Signed-off-by: Michaël Mattiello <mcm@odoo.com>
2021-11-04 11:35:50 +00:00
Géry Debongnie
992fbc6ece [IMP] developer: rework section on debug mode
closes odoo/documentation#1290

X-original-commit: b48f0cbad8
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 20:35:04 +00:00
Géry Debongnie
772e0945a9 [IMP] developer: add sections on pyjs and domains
closes odoo/documentation#1289

X-original-commit: da4dae597e
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 19:53:41 +00:00
Géry Debongnie
efb327479f [MOV] developer: move section on patching javascript
This commit is a move, but the content was also slightly
updated/reformatted.

closes odoo/documentation#1288

X-original-commit: f206233ebc
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-03 19:32:56 +00:00