Commit Graph

16 Commits

Author SHA1 Message Date
Jonathan Castillo
444bdfe31f [REM] content/applications/*: delete unused images 2021-06-08 13:01:16 +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
Victor Feyens
becf7a207d [FIX] content/applications/*: typos
found with codespell
2021-05-31 14:44:18 +02:00
Victor Feyens
0a4e0610c6 [FIX] content/administration/*: typos 2021-05-31 14:44:18 +02:00
Victor Feyens
e96bc804d3 [FIX] content/developer/*: typos
Found with codespell
2021-05-31 14:44:18 +02:00
Jairo Llopis
e1adedc2e5
[FIX] mail: how to choose allowed "From" addresses
- Document changes from https://github.com/odoo/odoo/pull/69218.
- Explain that Office365 is now usable.
2021-05-26 11:49:36 +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
dc49cd9e7b [IMP] *: links improvements
* use absolute paths when cleaner than relative paths
* fix some sphinx issues / todos
2021-05-17 15:32:24 +02:00
Victor Feyens
326de4b39e [FIX] *: absolute links to odoo.com/documentation 2021-05-17 15:32:24 +02:00
Antoine Vandevenne (anv)
1a0c122500 [IMP] contributing: update contributing guide for new documentation 2021-05-12 18:20:48 +02:00
Martin Trigaux
0fcc06c2db [FIX] legal: use direct links to pdf files
This avoids to have URL pointing to
https://www.odoo.com/documentation/user/<VERSION>/<LANG>/odoo_enterprise_agreement.pdf
when switching a language

The pdf are built only once and are global per version
2021-05-11 10:36:14 +02:00
Victor Feyens
ac99ad7abd [REM] *: patchqueue extension
Remove the patchqueue extension from the doc requirements since it isn't 
maintained anymore (raising warnings for recent sphinx versions) and the 
patches to specify code blocks aren't easy to maintain.

Remove hidden code patches, and replaces shown patches by code block / 
literalincludes to keep the useful content.
2021-05-10 17:24:23 +02:00
Ludvig Auvens
73806971a2 [ADD] IoT: New doc about how to connect a scale using the IoT box. 2021-05-10 10:54:50 +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