Commit Graph

26 Commits

Author SHA1 Message Date
Krzysztof Magusiak
8bc1f02a12 [IMP] core: remove @api.returns
closes odoo/documentation#11156

Related: odoo/odoo#182709
Related: odoo/enterprise#71424
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-12-20 01:03:17 +00:00
Krzysztof Magusiak (krma)
87b489d36e [IMP] core: odoo.domain
odoo/odoo#170009

closes odoo/documentation#10214

Related: odoo/enterprise#65013
Related: odoo/upgrade-util#99
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2024-12-17 13:47:14 +00:00
Krzysztof Magusiak
6395455f0b [IMP] core: SQLObject replaces _sql_constraints
task-3390431

closes odoo/documentation#11071

Related: odoo/odoo#175783
Related: odoo/enterprise#68589
Signed-off-by: Krzysztof Magusiak (krma) <krma@odoo.com>
2024-11-08 07:33:30 +00:00
Krzysztof Magusiak
11cc952979 [IMP] core: Deprecate toggle_active()
task-3983933

closes odoo/documentation#11261

Related: odoo/odoo#183691
Related: odoo/enterprise#71963
Signed-off-by: Krzysztof Magusiak (krma) <krma@odoo.com>
2024-10-23 13:30:32 +00:00
Gorash
f1a607a9c7 [IMP] *: Using class name corresponding to odoo models
closes odoo/documentation#11115

Related: odoo/odoo#178200
Related: odoo/enterprise#69762
Related: odoo/upgrade#6577
Related: odoo/design-themes#988
Related: odoo/upgrade-util#143
Signed-off-by: Christophe Matthieu (chm) <chm@odoo.com>
2024-10-15 09:33:04 +00:00
Vincent Schippefilt
564f2640c7 [IMP] base: add read_group relative granularity
references https://github.com/odoo/odoo/pull/159528

closes odoo/documentation#8447

Task: 3836802
Related: odoo/odoo#159528
Signed-off-by: Vincent Schippefilt (vsc) <vsc@odoo.com>
2024-04-25 17:11:23 +00:00
Rémy Voet (ryv)
5f2a5d318e [IMP] orm: add 'any' and 'not any' operators
- Add descriptions of the 'any' and 'not any' operators
- Simplify the example for searching partners
- Add an example using the 'any' operator for the sale.order model

closes odoo/documentation#8349

Closes: #7620
X-original-commit: 7353d7b2cc
Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2024-03-25 12:54:14 +00:00
Rémy Voet (ryv)
be60243eff [IMP] orm: update changelog for the new flush strategy
closes odoo/documentation#7194

Related: odoo/upgrade#5469
Related: odoo/odoo#144747
Related: odoo/enterprise#53380
Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2024-01-15 13:04:08 +00:00
Raphael Collet
2b8a578c9b [IMP] core: add SQL wrapper
This completes https://github.com/odoo/odoo/pull/134677.

closes odoo/documentation#6724

X-original-commit: 2662fa5437
Signed-off-by: Raphael Collet <rco@odoo.com>
2023-12-01 11:54:08 +00:00
Rémy Voet (ryv)
d105f614af [IMP] orm: update changelog
closes odoo/documentation#6465

X-original-commit: f1960a250c
Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2023-11-15 12:35:34 +00:00
Rémy Voet (ryv)
13544bca17 [IMP] orm: name_get into display_name
odoo/odoo#122085
odoo/enterprise#42599
odoo/upgrade#4780

closes odoo/documentation#4639

Signed-off-by: Rémy Voet (ryv) <ryv@odoo.com>
2023-06-28 17:41:15 +02:00
Rémy Voet (ryv)
584e44396b [ADD] add documentation about Model._read_group
task-3001022

odoo/odoo#110737

closes odoo/documentation#4064

Related: odoo/enterprise#38639
Signed-off-by: Rémy Voet <ryv@odoo.com>
2023-04-19 21:58:12 +02:00
Raphael Collet
097c247449 [IMP] core: introduce search_fetch() and fetch()
closes odoo/documentation#3749

Related: odoo/odoo#114551
Signed-off-by: Raphael Collet <rco@odoo.com>
2023-03-07 18:03:13 +01:00
Jonathan Castillo (jcs)
65d71dd7be [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#3589

X-original-commit: 7ae76bad42
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-15 16:03:06 +01:00
Xavier Morel
219a7cc82f [ADD] reference/orm: grouped method
closes odoo/documentation#2783

Related: odoo/odoo#101522
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-21 13:06:06 +02:00
Victor Feyens
3a7be7730d [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#2803

X-original-commit: 7c42ab8eaf
Related: odoo/odoo#102969
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-10 19:55:40 +02:00
Denis Ledoux
991b8142fe [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#2786

X-original-commit: 0bdf714112
Related: odoo/odoo#102117
Signed-off-by: Denis Ledoux (dle) <dle@odoo.com>
2022-10-04 18:06:37 +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)
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
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
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
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
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
2b2611e462 [IMP] developer: rename addons/js => backend/frontend
The terminology did not really make sense for a lot of these sub pages.
This change should have been done long ago, but was probably delayed
because some people in Odoo call the web client the "backend", which is
really misleading.

This commit also renames the title "Reference Guides" to "Reference",
since this section does not contain any guides anyway.

Part-of: odoo/documentation#1260
2021-11-02 14:00:09 +00:00