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
