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>
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
closesodoo/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>
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>
This adds a simple documentation for the editor's Powerbox and creates
the base for the editor's own documentation in general.
closesodoo/documentation#2586
Signed-off-by: Antoine Guenet (age) <age@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>
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
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.
closesodoo/documentation#2378
X-original-commit: 31a9d4a340
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
Only `no_create` is required to hide both the 'Create "xxx"' and the
'Create and Edit...' dropdown menu options.
closesodoo/documentation#2016
X-original-commit: 599a137ffc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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>
Recently, the API of useAutofocus has been simplified (see 4308de6aab).
Here we adapt its documentation.
closesodoo/documentation#1572
Signed-off-by: Mathieu Duckerts-Antoine <dam@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>
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.
closesodoo/documentation#1432
X-original-commit: 7763c22db4
Signed-off-by: Géry Debongnie <ged@odoo.com>
Signed-off-by: Luca Vitali <luvi@odoo.com>
The "qweb key of the manifest" file was still mentionned even if it has
been replaced by the assets bundles.
See related task: 2352566
closesodoo/documentation#1434
X-original-commit: dc832e1cc8
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
This commit applies some remarks by Antoine.
closesodoo/documentation#1328
X-original-commit: 8c1003e363
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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.
closesodoo/documentation#1326
X-original-commit: 1f84bab97d
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
and add entry for effects registry as well
closesodoo/documentation#1303
X-original-commit: 624131f712
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
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>
The preferred format for (frontend) references is now:
"frontend/filename/section", or something close to that.
closesodoo/documentation#1294
X-original-commit: 894165a949
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
This commit is a move, but the content was also slightly
updated/reformatted.
closesodoo/documentation#1288
X-original-commit: f206233ebc
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
- add a link to services
- add a note that the env is quite powerful
- reformat the table with the list-table role, to make it easier to edit
closesodoo/documentation#1268
X-original-commit: 1e6c12be30
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
This commit update the registry documentation to use the js domain
directives instead of trying to format functions with code blocks.
I am not impressed with the way it looks, but in any cases, it is
certainly better to properly structure the documentation.
closesodoo/documentation#1262
X-original-commit: ce96d6c584
Signed-off-by: Géry Debongnie (ged) <ged@openerp.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
This commit updates the documentation of the map view.
There were missing map attributes, typos and wrong descriptions.
closesodoo/documentation#1232
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
and move the section on environment to the framework main documentation
page.
closesodoo/documentation#1237
X-original-commit: 05ab4a7b0a
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
This commit moves most of the content out of the javascript reference
and into a more visible page.
closesodoo/documentation#1211
X-original-commit: c6f813f4cb
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
- Reference v15 training solutions
- Refer to Command namespace instead of triplets (e.g.
Command.create(values) instead of (0, 0, values)
- Add notice about OWL transition
- Add reference to @api.ondelete (instead of override unlink())
- Remove references to SavepointCase (now only TransactionCase) from
unit test topic
- Also add missing reference documentation for ondelete
closesodoo/documentation#1146
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Brings some modification to the documentation on cohort, graph, and
pivot views according to the recent refactoring of the reporting views
in owl.
Related commits:
closesodoo/documentation#1123
Community: odoo/odoo#73311
Enterprise: odoo/enterprise#19469
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
This commit relates to a new community feature:
A read_group on a date(time) field will also return a __range property with
the date bounds of the group [from, to[
The community commit also introduces a new xml attribute
`allow_group_range_value` for `<kanban>` `<field>`, and this commit is the
documentation for that attribute.
allow_group_range_value (boolean):
- to perform a drag&drop or a quickCreate, we must be able to get and use the
value from the group containing the record. The last date of the group will
be taken as the record's field value.
- allows (or disallows) date(time) non-readonly fields to be:
- draggable
- quick created
- defaults to false.
Task-ID: 2243913
Community PR odoo/odoo#69380
Commit: [IMP] core, web: add a range for date(time) read_group
* readonly is True for related fields.
Since Odoo 12: 52a8ed3c0c
This commit also highlights all the default values of related fields, fixing
the misleading message about related computed in sudo mode (since it can
be disabled with compute_sudo or related_sudo = False)
---
task-2451749
The new R&D training is intended to replace the existing technical
training(s). It is organized as follow:
- A core training, with chapters to follow in order (1 - 16)
- Advanced topics, with independent chapters (A - O)
The advanced topics should be done after the core training.
Co-authored-by: Nicolas Martinelli <nim@odoo.com>
Co-authored-by: Jorge Pinna Puissant <jpp@odoo.com>
Co-authored-by: wan <wan@odoo.com>
Co-authored-by: Xavier Morel <xmo@odoo.com>
Co-authored-by: Tiffany Chang (tic) <tic@odoo.com>
Prior to this commit, the Odoo documentation was mainly split between
two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits
of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...).
This was causing several problems among which:
- The theme, config, Makefile, and similar technical resources had to
be duplicated. This resulted in inconsistent layout, features, and
build environments from one documentation to another.
- Some pages did not fit either documentation as they were relevant
for both users and developers. Some were relevant to neither of the
two (e.g., DB management).
- Cross-doc references had to be absolute links and they broke often.
- Merging large image files in the developer documentation would bloat
the odoo/odoo repository. Some contributions had to be lightened to
avoid merging too many images (e.g., Odoo development tutorials).
- Long-time contributors to the user documentation were chilly about
going through the merging process of the developer documentation
because of the runbot, mergebot, `odoo-dev` repository, etc.
- Some contributors would look for the developer documentation in the
`odoo/documentation-user` repository.
- Community issues about the user documentation were submitted on the
`odoo/odoo` repository and vice-versa.
Merging all documentations in one repository will allow us to have one
place, one theme, one work process, and one set of tools (build
environment, ...) for all of the Odoo docs.
As this is a good opportunity to revamp the layout of the documentation,
a brand new theme replaces the old one. It features a new way to
navigate the documentation, centered on the idea of always letting the
reader know what is the context (enclosing section, child pages, page
structure ...) of the page they are reading. The previous theme would
quickly confuse readers as they navigated the documentation and followed
cross-application links.
The chance is also taken to get rid of all the technical dangling parts,
performance issues, and left-overs. Except for some page-specific JS
scripts, the Odoo theme Sphinx extension is re-written from scratch
based on the latest Sphinx release to benefit from the improvements and
ease future contributions.
task-2351938
task-2352371
task-2205684
task-2352544
Closes#945
