Commit Graph

28 Commits

Author SHA1 Message Date
Antoine Vandevenne (anv)
0a272f64ce [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#3149

X-original-commit: 359ab4d028
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-08 13:55:59 +01:00
Victor Feyens
b8ef59ef84 [FIX] *: remove trailing whitespaces
Part-of: odoo/documentation#2981
2022-11-18 17:42:18 +01:00
Victor Feyens
add6751897 [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#2859

X-original-commit: 758463edd4
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-25 18:53:47 +02:00
Jonathan Castillo (jcs)
c37f31b59a [IMP] *: Remove "SaaS" to keep only the "Odoo Online" appellation
task-3034812

closes odoo/documentation#2834

X-original-commit: eae71e6eda
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-10-21 15:27:35 +02:00
Xavier-Do
21a914e777 [ADD] developer/reference: add a reference page on performance
closes odoo/documentation#2791

X-original-commit: 4d8e3f9785
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Xavier Dollé (xdo) <xdo@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-06 13:21:03 +02:00
Max
093db643bb [FW][IMP] developer/backend: correct filters attribute for calendar view fields
closes odoo/documentation#2722

Forward-port-of: odoo/documentation#2692
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-09-15 17:09:45 +02:00
Antoine Vandevenne (anv)
b2c9765705 [MOV] developer/reference: move up the standard_modules directory
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".

closes odoo/documentation#2456

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-13 16:46:24 +02:00
Antoine Vandevenne (anv)
198137a2ef [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#2339

X-original-commit: e2a3ca0631
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-29 10:06:35 +02:00
Antoine Vandevenne (anv)
cfaefa48a1 [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#2066

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-20 14:48:38 +02:00
Antoine Vandevenne (anv)
250bc3ab21 [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#2066
2022-05-20 14:48:37 +02:00
wan
9db567159d [REF] i18n/localization.rst: rework the entire localization tutorial
closes odoo/documentation#1956

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: William Andre <wan@odoo.com>
Co-authored-by: Ivan Yelizariev <iel@odoo.com>
2022-05-09 12:19:00 +02:00
Dossogne Bertrand
1c67fb351c [FIX] developer: fix duplicate action availability
The duplicate action is not available for list views

closes odoo/documentation#1858

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

closes odoo/documentation#1850

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

X-original-commit: 1afdec3784
Part-of: odoo/documentation#1691
2022-03-11 14:44:53 +00:00
nle-odoo
db4f98d44e [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#1685

X-original-commit: b24560e224
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-10 14:59:51 +00:00
Antoine Vandevenne (anv)
0116d7dbc7 [REL] freeze saas-15.2 branch
closes odoo/documentation#1526
2022-02-04 12:25:44 +00:00
Demesmaeker
8966e001c2 [IMP] integration_testing: add information about JS touring
Adding basic information about `How to make a test tour`.

task-2742841

closes odoo/documentation#1524

X-original-commit: dbd5a1e1bb
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-02 15:55:41 +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
Jairo Llopis
4dc1223caf [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#1431

X-original-commit: 53cb375406
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 11:00:04 +00:00
Antoine Vandevenne (anv)
915f1805fd [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#1424

X-original-commit: a692dbdc9c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 09:27:29 +00:00
Tymoteusz Motylewski
dccdca0f41 [IMP] backend/testing: add link to unittest python library
closes odoo/documentation#1416

X-original-commit: a8fe35665b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-14 13:07:05 +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
Raf Geens
8db85a0caa [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#1282

X-original-commit: 77dd769b08
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Raf Geens <raf@odoo.com>
2021-11-05 08:57:39 +00:00
Géry Debongnie
0c5ceef042 [FIX] developer: document assets key in manifest, remove old info
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.

closes odoo/documentation#1261

X-original-commit: a2a389688c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-02 14:27:37 +00:00
Géry Debongnie
9bd739b36f [MOV] developer: move assets doc into frontend
Now that the reference is split into backend/frontend, it makes more
sense to have the assets page into the frontend section.

closes odoo/documentation#1260

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-02 14:00:09 +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