Commit Graph

20 Commits

Author SHA1 Message Date
Benoit Socias
5a446f5c59 [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#4823

Signed-off-by: Benoit Socias (bso) <bso@odoo.com>
2023-06-27 11:02:18 +02:00
Jonathan Castillo (jcs)
643834ced1 [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#3567

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-14 11:24:31 +01:00
Antoine Vandevenne (anv)
0b9279d52f [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#3051

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-08 10:00:21 +01:00
Victor Feyens
efb6c47e92 [FIX] *: remove trailing whitespaces
Part-of: odoo/documentation#2978
2022-11-18 17:33:14 +01:00
Victor Feyens
758463edd4 [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#2857

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-25 17:42:26 +02:00
Antoine Vandevenne (anv)
7f95e9e2e0 [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#2329

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-28 14:16:15 +02:00
Antoine Vandevenne (anv)
0fc521886f [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#2026

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-20 14:03:48 +02:00
Antoine Vandevenne (anv)
91c20a2c03 [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#2026
2022-05-20 14:03:47 +02:00
Dossogne Bertrand
19eddfdd3f [FIX] developer: fix duplicate action availability
The duplicate action is not available for list views

closes odoo/documentation#1855

X-original-commit: ce1961ebaf
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-25 10:47:12 +02:00
Dossogne Bertrand
e487e94ee6 [FIX] developer: fix duplicate availability
The duplicate action is not available for list views

closes odoo/documentation#1847

X-original-commit: 9cf425d886
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-22 18:11:24 +02:00
Antoine Vandevenne (anv)
1afdec3784 [IMP] developer/api/odoo: rework page to use examples and content tabs
task-2787415

Part-of: odoo/documentation#1688
2022-03-11 14:14:17 +00:00
nle-odoo
beda3f95ff [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#1682

X-original-commit: b24560e224
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-10 15:00:05 +00:00
Demesmaeker
a52f601bfb [FIX] integration_testing: fix wrong step utils used in tour
closes odoo/documentation#1519

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 13:29:46 +00:00
Demesmaeker
827270c513 [IMP] integration_testing: add information about JS touring
Adding basic information about `How to make a test tour`.

task-2742841

closes odoo/documentation#1516

X-original-commit: f6c1723fe0
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
2022-02-02 12:01:37 +00:00
wan
2bf697bda4 [ADD] extensions: add a custom example admonition
closes odoo/documentation#1501

X-original-commit: acda12669d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-28 10:42:56 +00:00
Jairo Llopis
6a995b48ff [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#1428

X-original-commit: 03a54e5b37
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 10:43:09 +00:00
Antoine Vandevenne (anv)
46cb0b8e9b [IMP] developer/*: replace occurrences of "access rule" by "record rule"
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/1118

closes odoo/documentation#1421

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-12-15 13:08:40 +00:00
Raf Geens
77dd769b08 [FIX] testing: Explain "new" tagging syntax
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.

closes odoo/documentation#1279

X-original-commit: 23d0a7a062
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-03 15:04:43 +00:00
Antoine Vandevenne (anv)
be1653cc51 [MERGE] Forward-port of branch 13.0 to 14.0 2021-07-07 15:39:35 +02:00
Fabien Pinckaers
16418c020b [IMP] *: introduce tables of contents in top-level app pages 2021-07-07 14:56:38 +02:00