Odoo documentation sources
Go to file
Mathieu (mano) c62bf21987 [IMP] odoo_theme: toctrees-l1,l2 design improvement
Issue 1:
========
The toctrees in the documentation are visually inconsistent because of
the content. Sometimes we have titles that are also links and visually
collides with the rest of the toc making it hard to read. This applies
to toctree-l1 and toctree-l2.

Fix 1:
========
When we have a link and title toctree-l2 in a list containing other
nested toc, we apply another styling displaying it with the same color
as a title, but with an icon and hover behavior indicating that it is a
link. (This commit also changes the direction of the i-link icon to make
it standard).

Issue 2:
========
When we have only have toctree-l1 links without nested toc the toctree
is uselessly taking a lot of space.

Fix: 2
========

In these scenario we add a class to the toctree wrapper to replace the
toctree-l1 style with a toctree-l2.

task-3138525
task-3138563

part of

task-3059178

closes odoo/documentation#4674

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-11-17 17:37:28 +00:00
.tx [I18N] migrate to the nex transifex API 2023-02-09 09:41:17 +01:00
content [IMP] inventory: expand on accounting and math 2023-11-12 22:54:05 +00:00
extensions [IMP] odoo_theme: toctrees-l1,l2 design improvement 2023-11-17 17:37:28 +00:00
locale [I18N] Update translation terms from Transifex 2023-11-12 03:40:20 +01:00
redirects [IMP] upgrade: overhaul upgrade doc 2023-11-09 11:21:41 +00:00
static [IMP] odoo_theme: design improvements 2023-04-11 16:43:55 +02:00
tests [IMP] tests: make review UX and resource files 2023-11-13 15:22:04 +00:00
.gitattributes [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-28 17:46:58 +02:00
.gitignore [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-28 17:46:58 +02:00
commit_template.txt [FIX] *: enforce 1 newline on files end 2022-11-18 17:33:13 +01:00
conf.py [IMP] supported_versions: release 17.0 2023-11-07 09:46:44 +00:00
COPYRIGHT [ADD] Add LICENSE and COPYRIGHT 2023-09-12 23:05:54 +00:00
LICENSE [ADD] Add LICENSE and COPYRIGHT 2023-09-12 23:05:54 +00:00
Makefile [IMP] tests: make review UX and resource files 2023-11-13 15:22:04 +00:00
README.md [IMP] README: remove version from links and rephrase explanations 2023-01-02 12:03:48 +01:00
requirements.txt [IMP] conf.py, requirements.txt, *: allow building with Python 3.10 2022-07-14 16:39:48 +02:00

Odoo documentation

Build the documentation locally

Requirements

  • Git
  • Python 3.6, 3.7, or 3.8
  • Python dependencies listed in the file requirements.txt.
  • Make
  • A local copy of the odoo/odoo repository (optional)

Instructions

  1. In a terminal, navigate to the root directory of the documentation and build it make. Additional commands are available with make help.
  2. Open the file documentation/_build/html/index.html in your web browser.
  3. See this guide for more detailed instructions.

Optional: place your local copy of the odoo/odoo repository in the parent directory or in the root directory of the documentation to build the latter with the documented Python docstrings.

Contribute to the documentation

For contributions to the content of the documentation, please refer to the Introduction Guide.

To report a content issue, request new content or ask a question, use the repository's issue tracker.

Learn More

To learn more about Odoo, in addition to the documentation, have a look at the official eLearning and Scale-up, The Business Game.