Commit Graph

75 Commits

Author SHA1 Message Date
Donatienne Pirlot (dopi)
f0550c30c6 [REM] developer/upgrade: remove outdated page
task-2613841

closes odoo/documentation#1082

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)
f8f784c0b0 [MERGE] Forward-port of branch 14.0 to master 2021-07-07 15:40:27 +02: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
Antoine Vandevenne (anv)
94e033c5e8 [MERGE] Forward-port of branch 14.0 to master 2021-06-25 16:03:40 +02:00
Martin Trigaux
192d9349c1 [MERFE] Froward port of 13.0 to 14.0 2021-06-14 16:11:22 +02:00
Jonathan Castillo
0fcc6fc9d8 [FIX] contributing: wrong doc reference to "memento" 2021-06-14 09:00:14 +02:00
Antoine Vandevenne (anv)
c3eb3f015e [MERGE] Forward-port of branch 14.0 to master 2021-06-11 17:06:51 +02:00
Antoine Vandevenne (anv)
cffb0b341a [MERGE] Forward-port of branch 13.0 to 14.0 2021-06-11 17:04:01 +02:00
Antoine Vandevenne (anv)
1f81173389 [MERGE] Forward-port of branch 12.0 to 13.0 2021-06-11 17:03:26 +02:00
Antoine Vandevenne (anv)
23a40f9748 [IMP] contributing: encourage flat pages hierarchy
task-2563614
2021-06-11 10:52:35 +02:00
Antoine Vandevenne (anv)
ec1dc7b632 [IMP] contributing: list supported metadata directives
The opportunity is also take to refresh the section about admonitions
and to add undocumented admonitions.

task-2534984
2021-06-11 10:52:35 +02:00
Antoine Vandevenne (anv)
f6d3c5628d [MERGE] Forward-port of branch 14.0 to master 2021-06-07 09:18:35 +02:00
Antoine Vandevenne (anv)
5469c2fb2c [MERGE] Forward-port of branch 13.0 to 14.0 2021-06-07 09:15:53 +02:00
Antoine Vandevenne (anv)
a8cfd6c6c5 [MERGE] Forward-port of branch 12.0 to 13.0 2021-06-07 09:09:43 +02:00
Antoine Vandevenne (anv)
fffaca7384 [FIX] contributing: fix admonition padding
The padding was not correctly set because the admonition was included
in an <ul> element which was itself inside another <ul> element.
The table below the admonition is also moved outside of the <ul>
because it is semantically incorrect.
2021-06-04 17:44:23 +02:00
Antoine Vandevenne (anv)
ddb5523d03 [REM] contributing: remove unused image file 2021-06-04 17:44:23 +02:00
Antoine Vandevenne (anv)
10e0a48ac0 [IMP] contributing: flatten hierarchy of "documentation" pages
The content of the introduction guide is moved to the parent page which
is itself renamed to "Write documentation". The homepage's quick links
are adapted accordingly.

The chance is also taken to move media files in the appropriate folder.

task-2558998
2021-06-04 17:44:23 +02:00
Antoine Vandevenne (anv)
2ded74bbd6 [MERGE] Forward-port of branch 14.0 to master 2021-05-12 18:35:42 +02:00
Antoine Vandevenne (anv)
79e716d41e [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-12 18:30:23 +02:00
Antoine Vandevenne (anv)
7b01bf417c [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-12 18:26:22 +02:00
Antoine Vandevenne (anv)
1a0c122500 [IMP] contributing: update contributing guide for new documentation 2021-05-12 18:20:48 +02:00
Antoine Vandevenne (anv)
74c9f94d16 [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-04 16:51:07 +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