Commit Graph

58 Commits

Author SHA1 Message Date
samueljlieber
97f9ae1b95 [FIX] clean unused resource files
Part-of: odoo/documentation#12010
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2025-02-13 08:44:14 +00:00
Antoine Vandevenne (anv)
e41e618116 [FIX] developer/reference/data: fix typo in data file example
The attribute of `record` data operations should be `id` and not `name`.

closes odoo/documentation#10602

X-original-commit: 2be7fa1c98
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-08-12 16:12:43 +00:00
XPL
e16a66706a [IMP] settings: simplify the developer mode page
task-3849915

closes odoo/documentation#9208

X-original-commit: df888df654
Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
2024-05-07 13:49:33 +00:00
Rémy Voet (ryv)
f1960a250c [IMP] orm: update changelog
closes odoo/documentation#1611

Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2023-11-15 10:40:22 +00:00
Mathieu Duckerts-Antoine
7a936c9f70 [FIX] search panel: fix bad indentation
closes odoo/documentation#6197

X-original-commit: 82055c1f15
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Mathieu Duckerts-Antoine (dam) <dam@odoo.com>
2023-10-23 14:19:03 +00:00
Levi Siuzdak (sile)
a7743d513b [IMP] developer: add notes on entity references & fix illegal XML
Using `<` inside XML elements will result in a parsing error,
an entity reference should be used instead: `&lt;`.

closes odoo/documentation#5159

Signed-off-by: Levi Siuzdak (sile) <sile@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-07-24 14:37:53 +02:00
Benoit Socias
77fe26c390 [IMP] developer/views: add optional attribute for fields of list views
The attributes of fields of list views do not mention the `optional`
attribute while it is used by chapter 12 of the R&D Training.

This commit describes this `optional` attribute.

task-3380953

closes odoo/documentation#4904

X-original-commit: 5a446f5c59
Signed-off-by: Benoit Socias (bso) <bso@odoo.com>
2023-06-27 16:07:00 +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
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
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
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
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
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
c367974170 [FIX] *: remove trailing whitespaces
Part-of: odoo/documentation#2983
2022-11-18 20:30:01 +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
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
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
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
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)
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
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
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
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
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
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
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