Commit Graph

14 Commits

Author SHA1 Message Date
Demesmaeker
f6c1723fe0 [IMP] integration_testing: add information about JS touring
Adding basic information about `How to make a test tour`.

task-2742841

closes odoo/documentation#1500

Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
2022-02-02 11:08:35 +00:00
wan
acda12669d [ADD] extensions: add a custom example admonition
closes odoo/documentation#1498

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-28 09:21:43 +00:00
Jairo Llopis
03a54e5b37 [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#1427

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-12-16 10:25:10 +00:00
Raf Geens
23d0a7a062 [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#1258

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2021-11-03 13:40:19 +00:00
Julien Van Roy
7fbf1c3ef2 [FIX] developer/reference: fix missing slash in javascript/qweb, debugging section
closes odoo/documentation#1207

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2021-10-22 12:52:37 +00:00
Fabien Pinckaers
16418c020b [IMP] *: introduce tables of contents in top-level app pages 2021-07-07 14:56:38 +02:00
Victor Feyens
40afc9d9f0 [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-31 14:54:23 +02:00
Victor Feyens
e96bc804d3 [FIX] content/developer/*: typos
Found with codespell
2021-05-31 14:44:18 +02:00
Antoine Vandevenne (anv)
647b6d924d [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-21 17:16:22 +02:00
Raf Geens
806761eec5
[FIX] developer: correct cr.execute signature in ORM doc
`cr.execute` takes a single argument which is a list, a tuple, or a dict.
2021-05-21 16:56:36 +02:00
Victor Feyens
87ab494b42 [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-17 18:29:11 +02:00
Victor Feyens
326de4b39e [FIX] *: absolute links to odoo.com/documentation 2021-05-17 15:32:24 +02:00
Antoine Vandevenne (anv)
8a6ad77935 [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-04 16:31:06 +02:00
Antoine Vandevenne (anv)
e3fee2cf46 [REF][MOV] documentation apocalypse
Prior to this commit, the Odoo documentation was mainly split between
two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits
of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...).
This was causing several problems among which:
  - The theme, config, Makefile, and similar technical resources had to
    be duplicated. This resulted in inconsistent layout, features, and
    build environments from one documentation to another.
  - Some pages did not fit either documentation as they were relevant
    for both users and developers. Some were relevant to neither of the
    two (e.g., DB management).
  - Cross-doc references had to be absolute links and they broke often.
  - Merging large image files in the developer documentation would bloat
    the odoo/odoo repository. Some contributions had to be lightened to
    avoid merging too many images (e.g., Odoo development tutorials).
  - Long-time contributors to the user documentation were chilly about
    going through the merging process of the developer documentation
    because of the runbot, mergebot, `odoo-dev` repository, etc.
  - Some contributors would look for the developer documentation in the
    `odoo/documentation-user` repository.
  - Community issues about the user documentation were submitted on the
    `odoo/odoo` repository and vice-versa.

Merging all documentations in one repository will allow us to have one
place, one theme, one work process, and one set of tools (build
environment, ...) for all of the Odoo docs.

As this is a good opportunity to revamp the layout of the documentation,
a brand new theme replaces the old one. It features a new way to
navigate the documentation, centered on the idea of always letting the
reader know what is the context (enclosing section, child pages, page
structure ...) of the page they are reading. The previous theme would
quickly confuse readers as they navigated the documentation and followed
cross-application links.

The chance is also taken to get rid of all the technical dangling parts,
performance issues, and left-overs. Except for some page-specific JS
scripts, the Odoo theme Sphinx extension is re-written from scratch
based on the latest Sphinx release to benefit from the improvements and
ease future contributions.

task-2351938
task-2352371
task-2205684
task-2352544

Closes #945
2021-05-04 15:44:00 +02:00