Commit Graph

21 Commits

Author SHA1 Message Date
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)
b30f28a3c4 [MERGE] Forward-port of branch 13.0 to 14.0 2021-06-09 12:22:50 +02:00
Antoine Vandevenne (anv)
251438d569 [MERGE] Forward-port of branch 12.0 to 13.0 2021-06-09 12:10:06 +02:00
Antoine Vandevenne (anv)
1d3375f1a8 [IMP] *: exclude empty TOC pages from search results
When searching for a string that can be found in a TOC page's content,
that page is listed in the search results. This is not a wanted behavior
because TOC pages without the 'show-content' metadata directive are not
supposed to be accessible.

This commit adds a 'nosearch' metadata directive to all TOC pages
without a 'show-content' metadata directive, hence removing them from
search results.

task-2527419
2021-06-09 11:55:34 +02:00
Jonathan Castillo
193e22492c [MERGE] Forward-port of branch 13.0 to 14.0 2021-06-04 17:21:14 +02:00
Jonathan Castillo
400b3f52b7 [MOV] general: renames "odoo_basics" into "users" + split content
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.

Since other docs were moved away from the section "basics" with previous
commits, this category is renamed "users settings"
This commit:
- renames "basics" into "users settings"
- moves the content from "odoo_basics/users" to "users"
  - it moves the content about "access rights" to a child doc

task-2535899
2021-06-04 13:51:18 +02:00
Jonathan Castillo
2fb77cf3ff [MOV] general: removes main "settings" section + move content
This commit is part of a larger work to improve the documentation's
structure. The toctree structure used to add levels to create categories
and make the structure visually more understandable.
With the new version of the documentation, plenty of these categories
are now redundant.

This commit:
- removes the main "settings" section
  - move its content to general/odoo_basics
- moves "general/mobile" content to "general"
- moves the content of the doc "developer_mode/activate" to "general"
  - it replaces the references to that doc with `:ref:` directives
    rather than `:doc:` directives
  - it is worth noting that it also fixes plenty of links that
    previously referred to "developer_mode" (the category) rather than
	"developer_mode/activate" (the document)

task-2535899
2021-06-04 13:51:18 +02:00
Victor Feyens
becf7a207d [FIX] content/applications/*: typos
found with codespell
2021-05-31 14:44:18 +02:00
Antoine Vandevenne (anv)
1758c674e6 [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-28 17:38:04 +02:00
Antoine Vandevenne (anv)
4ca0d019c7 [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-28 17:31:45 +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
Victor Feyens
8ad392222b [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-17 19:00:31 +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
Victor Feyens
6aea496f26 [MERGE] Forward-port of branch 13.0 to 12.0 2021-05-11 15:25:37 +02:00
Victor Feyens
3d9afc4c0e [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-11 15:13:58 +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)
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