This commit also moves all versions from 8.0 to 12.0 from the table to
the "older versions" section.
closesodoo/documentation#5304
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
"September" didn't fit in the current table, so this commit also
replaces the previous implementation of the table by a `list-table`
directive... The real reason is that it was long due to ease future
updates of the table.
closesodoo/documentation#4620
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
1) PDF files are generated and stored at the root of the CURRENT_BRANCH
directory. The links to those files are generated at different levels of
the doctree, which makes it impossible to use a relative path.
For example the same "Enterprise Agreement" doc in EN is published on:
- /16.0/legal/terms/enterprise.html
- /16.0/fr/legal/terms/enterprise.html
As a workaround, use absolute links for the PDFs. They won't work
locally for now. Can be improved later, as long as we don't break
those links located in various depths of the troctree.
2) The legal constracts aren't translated in all availables languages
(yet), so those links are 404s now. Introduced a conf.py variable
`legal_translations` with the list of languages where translated
contracts are indeed available, and falling back to the EN version
otherwise. Some languages don't have *all* the contracts translated, so
some 404 may remain temporarily.
The extension adds two new directive:
- `cards` is the row container for one or more `card` directives.
- `card` is the implementation of a Bootstrap card that accepts a
`target` argument for the href of the card, a `large` option to render
the card on two columns, and arbitrary content that is shown in the
card body.
task-3141419
closesodoo/documentation#3355
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit replaces hard-coded occurrences of the version and of the
last, current and next releases' version with placeholders interpolated
at build time to avoid manually updating these after each freeze.
task-2917614
closesodoo/documentation#3051
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Prior to this commit, the terms and conditions were displayed in a table
with all the languages and it was not practical for the futur, with many
more languages.
task-3073198
closesodoo/documentation#3058
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
It is often needed in developer tutorials to show excerpts of code for
examples and solutions. This takes quite some page space and, for the
latter, it is not always desired to show the final code result right
after the exercise objective.
This commit adds a spoiler feature to the documentation to allow hiding
content until the reader wants to display it.
The feature relies on the new `.. spoiler:: Button label` directive.
task-3036845
closesodoo/documentation#2837
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Morgan Meganck <morm@odoo.com>
Co-authored-by: Stefano Rigano <sri@odoo.com>
- Bump Sphinx version to 4.3.2 (default for Debian Jammy).
- Remove the retrocompatibility for Sphinx < 3.5 (warnings are raised in
4.5).
- Fix translator issue crashing builds.
- Unpin jinja2 from the requirements as the base issue is solved in sphinx 4
Task - 2898477
closesodoo/documentation#2361
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
The branch was recently dropped from the supported versions. We no
longer need to add a label for it in the version switcher.
closesodoo/documentation#2432
X-original-commit: 2481e3d842
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The `redirects.txt` file used to specify redirect rules for renamed or
moved documentation pages is starting to grow too big to be easily
maintainable. The main reason is that the number of redirect rules that
were thought to be required has been largely underestimated when
implementing the 'redirects' extension. At first, we believed that no
guidelines or structure were necessary because only a small amount of
redirect rules would be specified. This proved wrong and the file is now
becoming a mess, making it increasingly difficult to figure out where,
why, when, and if a redirect rule is specified in the file.
As the file is versioned, another issue emerges: conflicts occur every
time a commit is forward-ported to a later version if that commit adds a
redirect rule at the end of the file or at a line that was changed in
the later version. As redirect rules are frequently added, and since
blocks of redirect rules for new versions are added at the end of the
file, this tends to happen a lot.
This commit attempts to hit two birds with one stone by splitting the
`redirects.txt` file into multiple files, one per version. While doing
so, the existing redirect rules are ordered alphabetically and moved
into contextual blocks. Instructions and guidelines on how to create
redirect rules are also listed in the `redirects/MANUAL.md` file. By
sorting the redirect rules and adding them in different files, the
number of conflicts should decrease by a lot.
task-2891912
closesodoo/documentation#2267
X-original-commit: 80c7b27827
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Before this commit, the language names were translated to display
"Français" instead of "French". This helped the user find their language
in the switcher but it was taking too much horizontal space, and that
space was not constant from one language to another.
This commit removes the translations of the language names and simply
goes with "FR", "NL", etc. which any user can identify as their
language.
task-2800937
X-original-commit: b1fa30f431
The 'sphinx-tabs' extension is better in every aspect:
- Synchronize selected tabs (group tabs feature).
- No need for extra `code-block` directive (code tabs feature).
- Better looking.
- No custom Python, JS, or CSS.
task-2787415
Part-of: odoo/documentation#1688
This commit improves current css style added by default to the Odoo
Documentation's content tabs.
This design improvement has been made by following the current theme's
style, especially in terms of palette and borders.
Tabs are responsive and have been optimised in order to have a
cross-browser compatibility.
--
Task-2755240
closesodoo/documentation#1662
X-original-commit: 7250f88b8d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
From now on, the master branch and the latest released SaaS branch are
always shown. SaaS branches are labeled "Odoo Online".
The list of the versions shown in the switcher is hard-coded to force
their ordering.
The class `dropdown-toggle` is always added to the version|language
switcher regardless of whether other versions|languages are available,
as a quick fix to a CSS issue that occurs when the class is missing.
closesodoo/documentation#1577
X-original-commit: fb469b8211
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
In `conf.py`, we try to find a Odoo sources folder among `odoo` and
`../odoo` directories without really checking that they really are
Odoo sources folders, leading to doc generation error if it's not the case.
So, to improve that, this commit checks that the selected Odoo sources folder
contains `odoo-bin`.
While we're at it, the logging is also improved to always display the
matching odoo sources' folder and version.
closesodoo/documentation#1339
X-original-commit: f72e557f2c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne <anv@odoo.com>
Building documentation implies some constraints: the source folder is
readonly, mainly because the sources are shared accros builds.
This implies that nor a symlink and a _build dir cannot be added in the
source directory.
The symlink will work in most cases localy for user with strange
multiverse structure, but if not found, the fallback will check in
parent directory. Most users and runbot will have all sources in the
same directory (both in universe and basic multiverse cases)
-(version?)
-odoo
-enterprise
-upgrade
-documentation
The second change will check if BUILD_DIR is defined before setting it,
allowing to use 'make BUILD_DIR=../build' to output the documentation
somewhere else.
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.
