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
X-original-commit: e2c880aafe
Part-of: odoo/documentation#4035
The allow_group_range_value option is used in one arch of a kanban in
CRM. We therefore believe that this is not standard behaviour.
So we decided to move this logic to the custom view that uses it.
closesodoo/documentation#3964
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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.
closesodoo/documentation#3589
X-original-commit: 7ae76bad42
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
Since [1], it's able to use of the setting tag in any form view.
[1]: 4cdd74fc585009a19a7d307f08411ad19255f8ff
closesodoo/documentation#3403
Signed-off-by: Aaron Bohy (aab) <aab@odoo.com>
Since the conversion of the list view to owl, the relative field size has not been reimplemented. We have decided not to support it anymore. So we will remove all its uses.
The relative width consists in adding a width attribute with an integer value. This value corresponds to the weight of the field, the higher it is, the more space the field will take. This size is only used when the list is empty.
Example of this:
<tree>
<field ... width="2">
<field ... width="1">
</tree>
The first field will take 2x more space than the first one when the list is empty.
closesodoo/documentation#3375
Related: odoo/odoo#110382
Related: odoo/enterprise#36020
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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.
closesodoo/documentation#3325
X-original-commit: 54628b4f5b
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>
This commit add the documentation for the new 'kanban-menu' template
(the ellipsis dropdown menu).
No that, this commit add also the documentation for the 'kanban-tooltip'
template.
closesodoo/documentation#3284
Task-id: 3096776
Related: odoo/odoo#107589
Related: odoo/enterprise#34962
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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
closesodoo/documentation#3170
X-original-commit: fa2d0f6363
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit, add the documentation of the new DSL created exclusively
for the settings.
closesodoo/documentation#3092
Task-id: 3081367
Signed-off-by: Jorge Pinna Puissant (jpp) <jpp@odoo.com>
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.
closesodoo/documentation#2862
X-original-commit: 758463edd4
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
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
closesodoo/documentation#2822
X-original-commit: 93b383e95d
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Move Environment explanation to the class docstring and autogenerate the
doc
Add documentation on some util methods.
closesodoo/documentation#2803
X-original-commit: 7c42ab8eaf
Related: odoo/odoo#102969
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
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.
closesodoo/documentation#2786
X-original-commit: 0bdf714112
Related: odoo/odoo#102117
Signed-off-by: Denis Ledoux (dle) <dle@odoo.com>
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
closesodoo/documentation#2551
Related: odoo/odoo#97321
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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.
closesodoo/documentation#2550
Related: odoo/odoo#96517
Related: odoo/enterprise#29824
Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com>
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".
closesodoo/documentation#2459
X-original-commit: 62e80093bd
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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
closesodoo/documentation#2342
X-original-commit: e2a3ca0631
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The previous file name was not very relevant in regard to the content of
the page, and it conflicted with the `sys.path`.
closesodoo/documentation#2068
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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
closesodoo/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>
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.
closesodoo/documentation#1908
Related: odoo/odoo#90634
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
The duplicate action is not available for list views
closesodoo/documentation#1860
X-original-commit: ce1961ebaf
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The duplicate action is not available for list views
closesodoo/documentation#1853
X-original-commit: 9cf425d886
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The tags`add`, `remove` and `separator` are not included in the
documentation.
closesodoo/documentation#1741
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
In d46e358d3e88aea9f9289c4845c6c87ab9491c55 some mail.thread method
names were changed: it should be changed in documentation too.
closesodoo/documentation#1686
X-original-commit: b24560e224
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Introduce changelog of the ORM by version, link to first change documented
closesodoo/documentation#1508
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Adding basic information about `How to make a test tour`.
task-2742841
closesodoo/documentation#1524
X-original-commit: dbd5a1e1bb
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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/1118closesodoo/documentation#1424
X-original-commit: a692dbdc9c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
- 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
closesodoo/documentation#1352
Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com>
* 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
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.
closesodoo/documentation#1282
X-original-commit: 77dd769b08
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Raf Geens <raf@odoo.com>
This commit adds a pretty important missing piece of information: the
assets key in the manifest. At the same time, we remove two keys that
are no longer in use.
closesodoo/documentation#1261
X-original-commit: a2a389688c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Now that the reference is split into backend/frontend, it makes more
sense to have the assets page into the frontend section.
closesodoo/documentation#1260
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
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
