Commit Graph

10 Commits

Author SHA1 Message Date
Antoine Vandevenne (anv)
09a100dbdb [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 

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-20 16:08:16 +02:00
Antoine Vandevenne (anv)
1d5e549b36 [MOV] content/*: move resource files into their related page's directory
Since , 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: 
2022-05-20 16:08:16 +02:00
Antoine Vandevenne (anv)
7f0b281d29 [IMP] developer/api/extract_api: rework page to get rid of switchers
task-2787415

closes 

X-original-commit: 85b7200944
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-11 14:45:00 +00:00
Antoine Vandevenne (anv)
8d4bf8f379 [IMP] developer/api/odoo: rework page to use examples and content tabs
task-2787415

X-original-commit: 1afdec3784
Part-of: 
2022-03-11 14:45:00 +00:00
Chris Parker
b305db3c0d [FIX] api/odoo: reflect the correct location of menu actions
closes 

X-original-commit: beb92c9f18
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-14 12:08:44 +00:00
Antoine Vandevenne (anv)
f29549b144 [FIX] extract_api: bring back extract_api doc lost with be1653cc
closes 

X-original-commit: 59df6b90ae
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-20 07:38:46 +00:00
“odoo-frc”
fe1065b044 [IMP] iap_tools: Update doc about iap_charge & authorize
closes 

Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
2021-08-17 11:58:21 +00:00
Donatienne Pirlot (dopi)
f0550c30c6 [REM] developer/upgrade: remove outdated page
task-2613841

closes 

X-original-commit: eee063a8b1
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
2021-08-03 14:35:58 +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