Commit Graph

191 Commits

Author SHA1 Message Date
Antoine Vandevenne (anv)
72e636da5f [ADD] extensions/cards: add an extension to implement cards
The extension adds two new directive:
- `cards` is the row container for one or more `card` directives.
- `card` is the implementation of a Bootstrap card that accepts a
  `target` argument for the href of the card, a `large` option to render
  the card on two columns, a `tag` option to display a single arbitrary
  tag on the card, and arbitrary content that is shown in the card
  body.

task-3141419

closes odoo/documentation#3672

X-original-commit: 48571c05a4
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-27 16:01:07 +01:00
Antoine Vandevenne (anv)
ff8c242d01 [MOV] developer/cli: move "Command-line interface (CLI)" to the reference dir
task-2991663

closes odoo/documentation#3644

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-22 14:31:26 +01:00
Antoine Vandevenne (anv)
a8e8a7b1c9 [MOV] developer/api/extract_api: move "Extract API" to the reference dir
task-2991663

Part-of: odoo/documentation#3644
2023-02-22 14:31:26 +01:00
Antoine Vandevenne (anv)
fe6f9d42ff [MOV] developer/api/external_api: move "External API" to the reference dir
task-2991663

Part-of: odoo/documentation#3644
2023-02-22 14:31:26 +01:00
Antoine Vandevenne (anv)
25c44f8caa [MOV] developer/api/iap: move "In-App Purchase" to the howtos dir
task-2991663

Part-of: odoo/documentation#3644
2023-02-22 14:31:26 +01:00
Antoine Vandevenne (anv)
087c9aee73 [MOV] developer/iot: move "Internet of things" the howtos dir
task-2991663

Part-of: odoo/documentation#3644
2023-02-22 14:31:25 +01:00
Antoine Vandevenne (anv)
e61fbafb0d [IMP] tutorials/*: hide outdated tutorials
*: backend, web, website

task-2991663

Part-of: odoo/documentation#3644
2023-02-22 14:31:25 +01:00
Antoine Vandevenne (anv)
3a24384582 [MOV] howto/web: move "Customizing the webclient" to the tutorials dir
task-2991663

Part-of: odoo/documentation#3644
2023-02-22 14:31:25 +01:00
Antoine Vandevenne (anv)
535103974b [MOV] howto/website: move "Building a website" to the tutorials dir
task-2991663

Part-of: odoo/documentation#3644
2023-02-22 14:31:25 +01:00
Antoine Vandevenne (anv)
f38a85a584 [MOV] howtos/backend: move "Building a module" to the tutorials dir
task-2991663

Part-of: odoo/documentation#3644
2023-02-22 14:31:24 +01:00
Antoine Vandevenne (anv)
41cf87f57e [MOV] tutorials/getting_started/*: promote advanced chapters to independent tutorials
task-2991663

Part-of: odoo/documentation#3644
2023-02-22 14:31:24 +01:00
Antoine Vandevenne (anv)
c140f7de4e [MOV] howto/rdtraining: move "Getting started" to the tutorials dir
This commit also replaces references to the "Building a module"
tutorial by references to the "Getting started" tutorial.

task-2991663

Part-of: odoo/documentation#3644
2023-02-22 14:31:24 +01:00
Antoine Vandevenne (anv)
642b027d44 [ADD] developer/tutorials: add a directory for developer tutorials
task-2991663

Part-of: odoo/documentation#3644
2023-02-22 14:31:24 +01:00
Jonathan Castillo (jcs)
c5434ccd0a [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#3568

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-02-14 14:27:44 +01:00
Mahmoud Metwally
784963e89d [FIX] developer/howtos: typos and phrasing
closes odoo/documentation#3541

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-02-13 12:51:54 +01:00
Mahmoud Metwally
65347b99b4 [FIX] developer/javascript_reference: typos and phrasing
closes odoo/documentation#3470

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2023-02-02 15:18:41 +01:00
Jonathan Castillo (jcs)
9a0bf7bb0e [IMP] accounting: update how to get api keys for silverfin integration
task 2918697

closes odoo/documentation#3416

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2023-01-27 10:18:01 +01:00
Mathieu (mano)
64fc72b6ca [IMP] toctrees: redesign and new card component
The goal of this commit is to propose a first step towards a new
`.. card::` directive for the toctrees. This is a first design
proposition for this new card component in raw html for the fallback
page `howtos.rst`

The long term objective is to redesign the toctrees by implementing card
components, clearer toctree list design and custom html pages.

Related to task-3059229

closes odoo/documentation#3404

X-original-commit: c59663f252
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-26 19:08:44 +01:00
Mahmoud Metwally
8cde1f7b74 Update qweb.rst
closes odoo/documentation#3246

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-04 11:03:06 +01:00
Mahmoud Metwally
840b97cb49 [FIX] rdtraining: fix writing errors
closes odoo/documentation#3250

X-original-commit: ad91dd67c2
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-03 10:56:22 +01:00
Antoine Vandevenne (anv)
beb0317832 [ADD] contributing/development: add a guide to contribute to the codebase
In addition, this commit extracts the git guidelines from the coding
guidelines. This helps link the git guidelines and unclutter the coding
guidelines, which should focus on only the programming languages.

task-2897123

Part-of: odoo/documentation#3249
2023-01-02 18:47:51 +01:00
Horacio Tellez
3c9b87be30 [FIX] rdtraining: remove outdated line about journal_id in chapter 14
In chapter 14 there was a line pointing to how to deduce a default journal for an `account.move` record.
This is no longer needed as the journal is automatically deduced using the `move_type`. Also, the link
point to an outdated line of code that causes an error.

closes odoo/documentation#3179

X-original-commit: 67a75a3e11
Signed-off-by: Horacio Tellez Perez (hote) <hote@odoo.com>
2022-12-12 10:10:44 +01:00
Antoine Vandevenne (anv)
359ab4d028 [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#3142

X-original-commit: 0b9279d5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-08 11:46:38 +01:00
Ivan Kropotkin
38dc4ceca5 [FIX] developer/reference: code example
closes odoo/documentation#2943

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-24 16:31:39 +01:00
Victor Feyens
6b38785b75 [IMP] developer/howtos: deprecate themes tutorial
This tutorial was already outdated in 13.0 (but
supposedly working).

In 14.0+, a lot of changes happened in website logic,
especially for 'website option definitions', breaking
the existing theme tutorial.

Considering the fact that a new tutorial is being made,
and that fixing the whole existing tutorial would be
a big work, it will be kept, but hidden as 'most things
being said still make sense'.

closes odoo/documentation#3002

X-original-commit: 9cc60baf46
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-21 19:15:38 +01:00
Victor Feyens
2a933246dd [FIX] developer/mobile: use spaces and not tabs for indentation
closes odoo/documentation#2980

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-18 17:32:59 +01:00
Victor Feyens
f1216a9f59 [FIX] *: unbalanced literal markups
Part-of: odoo/documentation#2980
2022-11-18 17:32:59 +01:00
Victor Feyens
c24d780387 [FIX] *: remove trailing whitespaces
Part-of: odoo/documentation#2980
2022-11-18 17:32:59 +01:00
Victor Feyens
cf2b1b934d [FIX] *: enforce 1 newline on files end
Part-of: odoo/documentation#2980
2022-11-18 17:32:58 +01:00
Victor Feyens
5128208495 [CLN] core: upgrade to python 3.6
& sort imports

closes odoo/documentation#2957

X-original-commit: 8a5aa384d3
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-15 20:19:10 +01:00
Victor Feyens
87a76ebdce [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#2858

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

closes odoo/documentation#2833

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-10-21 13:51:54 +02:00
Elias
e21dbd01c9 [FIX] developer/howtos/rdtraining: Update warning message
Update warning output for missing access rules.
Also reflect up-to-date contents of res.country.state.csv.

closes odoo/documentation#2790

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-10-18 11:14:39 +02:00
Xavier-Do
4d8e3f9785 [ADD] developer/reference: add a reference page on performance
closes odoo/documentation#1180

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-10-06 11:21:48 +02:00
Aleksander
43621e7042 [IMP] howtos/rdtraining: give the meaning of "ACL"
closes odoo/documentation#2774

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-30 10:18:45 +02:00
Claire Bretton (clbr)
5e3dbc0201 [IMP] developer/howtos/rdtraining: Add missing information about module category.
Adds explanations and directive for module category creation, so it can be used correctly at res.groups creation.

closes odoo/documentation#2726

X-original-commit: 338fe297b0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-16 15:58:49 +02:00
Max
980edde1e5 [IMP] developer/backend: correct filters attribute for calendar view fields
closes odoo/documentation#2692

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-09-15 14:15:45 +02:00
Julien Castiaux
79e58e3db1 [IMP] developer/api/external_api: XML-RPC in PHP8
Starting PHP8, the XML-RPC extension is not available by default
anymore and must be installed separately.

closes odoo/documentation#2481

Task: 2613818
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-09-14 10:26:51 +02:00
Julien Castiaux
83c2e6de0b [IMP] content/developer/webservices
It is hard to find and learn about RPC in Odoo, users hardly know about
JSON-RPC as the only place where we talk about it in deep down in the
*How to make a Module* tutorial.

In the commit, we isolated the tutorial about RPC in a dedicated file,
that file is better referenced thanks to cross-references in some others
places that are talking about RPC

Task: 2884559
Part-of: odoo/documentation#2481
2022-09-14 10:26:51 +02:00
std-odoo
2a01b21800 [IMP] mail: add documentation about the SSL SMTP authentication
Purpose
=======
Add the documentation about the SSL SMTP authentication
(2 new binary arguments) and also about the new from
filter binary argument.

The goal of those new arguments is to improve the score
of the emails sent by Odoo.

Task 2367946
See odoo/odoo/pull/61853
See odoo/upgrade/pull/1903

closes odoo/documentation#973

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-09-12 14:09:40 +02:00
poma-odoo
d204fe743f [FIX] developer/frontend: small typos
closes odoo/documentation#2584

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-08-18 14:17:41 +02:00
Antoine Vandevenne (anv)
1c4d9ced44 [IMP] rdtraining: mention that the second part needs to be completed too
closes odoo/documentation#2537

X-original-commit: 9279fb80a7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-08-01 15:53:35 +02:00
Victor Feyens
86cfcd5246 [CLN] rdtraining: remove reference to unexisting file
The referenced `bypass.py` file isn't specified anywhere in
the training documentation or code content.

The paragraph is removed to avoid meaningless searches and
confusing trainees.

This commit also adds a missing parenthese in the preceding
code content.

Fixes #2488

closes odoo/documentation#2519

X-original-commit: 1c4abe4e07
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-25 15:52:11 +02:00
Benoit Socias
3c984344d9 [IMP] rdtraining: update float utils information
The warning about float utils does not state where to find them, and
they are preceded by an example in the code that infringes the warning's
recommendation.

This commit indicates where to find the float utils and replaces the
example by one that uses them.

task-2925402

closes odoo/documentation#2508

X-original-commit: b8ee134a28
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-20 15:30:58 +02:00
Victor Feyens
60adfacbc9 [FIX] accounting_localization: use relative paths in csv-table's option
The `file` option for the `csv-table` directive expects relative file
paths rather than absolute file paths since Sphinx 4. Since this was the
only usage of the `ODOO_ABSPATH` placeholder, it is removed with this
commit.

Task - 2898477

closes odoo/documentation#2362

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-07-14 17:38:42 +02:00
Antoine Vandevenne (anv)
bdafd7c1bf [IMP] developer: rename reference directories to "Py/Js framework"
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.

closes odoo/documentation#2445

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-12 16:29:56 +02:00
Antoine Vandevenne (anv)
44fd054858 [IMP] developer/rdtraining: simplify the development environment setup
In an attempt to help new developers install Odoo with a
straightforward procedure, Chapter 2 of the "Getting started" tutorial
included copy-pastes of parts of the "Installing Odoo" page. This proved
to be inefficient because it required maintaining documentation on the
installation procedure in several places and misled the readers by
suggesting installing the Python requirements *after* installing
PostgreSQL.

With this commit, the page on Chapter 2 is refreshed to be clearer to
the readers and redirect them to the "Installing Odoo" page when
necessary.

task-2908434

closes odoo/documentation#2440

X-original-commit: 11460f4c93
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-12 15:12:04 +02:00
Antoine Vandevenne (anv)
31a9d4a340 [IMP] developer/javascript: unify the styling of API references
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.

closes odoo/documentation#2367

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-04 15:22:27 +02:00
Antoine Vandevenne (anv)
109817311e [MOV] developer/misc: move all pages to a more logical location
Before this commit, the "Developer/Misc" directory of the doc, and
more particularly the "Developer/Misc/Other" sub-directory, was used as
a garbage dump where we moved all the pages that didn't fit elsewhere.
Due to that, interesting and important pages, such as the Coding
Guidelines, were buried in that directory never to be read again by Odoo
developers.

This commit moves most pages under "Misc" one or two levels up to be
located directly under "Developer" hence making them more accessible. A
new "Contributing/Development" directory is added to host the Coding
Guidelines page and soon many other pages.

task-2897143

closes odoo/documentation#2368

X-original-commit: 4e67b8986c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-04 11:57:52 +02:00
Antoine Vandevenne (anv)
e2a3ca0631 [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#2336

X-original-commit: 7f95e9e2e0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-28 18:32:10 +02:00