Prior to this commit, users had to either know in advance or guess the
location of the content they were looking for. Top-level pages of the
"Developer" section of the documentation, in particular the "Developer"
page itself, were listing their sub-pages without directions for users.
This commit brings the following changes to improve the navigation:
- add directions for users on the "Developer" page and list the three
main categories of developer documentation ("Tutorials", "How-to
guides", and "Reference") with explanations of their content and
target audience;
- add categories for content cards on the "Tutorials" and "How-to
guides" pages, and fine-tune the toctree of the "Reference" page to
more easily locate specific topics;
- clarify what are the "Python framework" and the "JavaScript framework"
by relabelling them to "Server framework" and "Web framework" on
top-level pages, as some users were confused to find that the JS
framework was not responsible for the server, and others that the
documentation for QWeb template is located in the Python documentation;
- extract the "Setup guide" from the "Getting started" tutorial and
rename the latter to "Server framework 101" to allow reusing the setup
guide in other tutorials and make clear that the "Server framework 101"
tutorial is not about the Web framework.
task-3802536
closesodoo/documentation#8597
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Valeriya (vchu) <vchu@odoo.com>
Legal terms live under specific URL as their translations are not
managed in the same manner.
Layout is like this:
/terms/enterprise.html (EN)
/terms/i18n/enterprise_fr.html (FR)
This commit adapts the generation of alternative languages links for each
"legal terms page", so that it targets the correct i18n link, or goes
back to the canonical EN one, depending on the target language.
closesodoo/documentation#7382closesodoo/documentation#7384closesodoo/documentation#7387
Signed-off-by: Olivier Dony (odo) <odo@odoo.com>
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
closesodoo/documentation#6511
X-original-commit: c62bf21987
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Before this commit, the Odoo logos used in the documentation were
using the old purple color.
This commit updates all these old logos with the latest version that
can be found on the Odoo brand-asset page
https://www.odoo.com/page/brand-assets
task-3328677
closesodoo/documentation#5604
X-original-commit: 4bec9a6e09
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The documentation of the views is redone in order to be up to date and
has allowed a better visualization of the task on the modifiers.
task-2495504
closesodoo/documentation#3523
Related: odoo/odoo#104741
Related: odoo/enterprise#35255
Related: odoo/upgrade#4884
Signed-off-by: Julien Castiaux (juc) <juc@odoo.com>
Attempting to switch from one version to another when navigating
<old_version>/applications/hr/employees.html led to the user being
redirected to /applications/documentation/<new_version>/hr/employees.html
because `hr` was interpreted as a version string, and thus the generated
target URLs of the version switcher were all wrong.
This commit ensures the redirection now falls back onto the original
target URL when all the generated ones point to a 404.
closesodoo/documentation#5059
X-original-commit: c81a91db9c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
When searching for a word, if that word happens to be in the menu, the
`display-flex` on the `a` would remove the space around the word because
a `span class=highlight` gets added around it.
Fixed by changing `display-flex` on the `a` to display-block (but
keeping it for `.o_toc_entry_wrapper`)
closesodoo/documentation#4185
X-original-commit: c758071861
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Revamp of the side menu;
Round all borders for consistency with the buttons;
Improve .sig-* and .o_code elements;
Improve sphinx-tabs hover effect;
task-3046383
closesodoo/documentation#4114
X-original-commit: 3056c7b62d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
A general reorganization of the code was needed for more clarity.
The different markup styles have been grouped together under a common
"chapter", comments have been rewritten and example pages have been
added for context.
Some levels have been removed Where there were too many for no reason.
By removing one level of styles (e.g.: `#wrap`) we avoid needing to
force overrides or adding `!important` to our code.
⌙ e.g.: before commit 9ef86cd93d8c6fc0fd96b437f629237e7a562c6e,
`.o_spoilers .accordion-body >:first-child` was being involuntarily
overridden.
task-3046383
X-original-commit: 620e3c33ef
Part-of: odoo/documentation#4114
The structure of the `dfn` role is changed from its default
`<em class="dfn">text</em>` to
`<span class="dfn"><span>text</span></span>` to ease the styling.
task-3046383
X-original-commit: 281a893540
Part-of: odoo/documentation#4114
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.
Forward-port of f69dba70be
This commit also replaces references to the "Building a module"
tutorial by references to the "Getting started" tutorial.
task-2991663
X-original-commit: 4f4e346953
Part-of: odoo/documentation#3660
The goal of this commit is to propose a first step towards a new
`.. card::` directive for the toctrees. This is a first design
proposition for this new card component in raw html for the fallback
page `howtos.rst`
The long term objective is to redesign the toctrees by implementing card
components, clearer toctree list design and custom html pages.
Related to task-3059229
closesodoo/documentation#3408
X-original-commit: 64363d8640
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Add a new content focused on SCSS and user-interface.
- SCSS coding guidelines: regroup information already available (eg [1])
or based on "oral tradition".
The aim is not to establish new rules, ~99% of the current codebase
is already compliant.
- SCSS inheritance: explain how SCSS assets management works in odoo.
For example, people still find confusing that overrides are defined
*before* the variable to customize.
- SCSS optimization tips: suggestions to lean SCSS code. Based on SCSS
optimization task's know-how [2].
- CSS variables: explain how this feature is commonly used in odoo to
adapt layout & design without raw CSS overrides.
- UI Icons: Add link to fontAwesome4 library . Replace the picture of
odoo icons with the actual font (90kb image VS 15Kb font)
[1] https://github.com/odoo/odoo/wiki/SCSS-coding-guidelines
[2] https://www.odoo.com/web#id=2704984&menu_id=4720&cids=1&model=project.task&view_type=form
task-3090800
closesodoo/documentation#3327
X-original-commit: 2ca32b40bc
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
While doing the changes on the text-dark issue, we noticed the
homepage's text color isn't aligned with the rest of the website.
`.text-muted` was too light, so we changed it to `.text-dark`.
X-original-commit: ee2390fdaf
Part-of: odoo/documentation#3320
This was changed to get a good text/background contrast on the
alert-dark (Exercise).
By doing so, the .text-dark class generated by BS from the $dark
theme-color was gray instead of the intended near-black color.
By changing the variable, the contrast issue with the alert was back,
to solve this we directly override the alert's background color instead.
X-original-commit: 32c9e59ae6
Part-of: odoo/documentation#3320
Trying to "expand" those pages lead to a crash that prevented the menu
to be shown at all.
Incidentally, this commit also handles menus built with `make fast`.
closesodoo/documentation#3275
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
In large and deeply nested TOCs like finance/accounting/fiscal_localizations/localizations/...
the user had to constantly scroll the menu to the menu entry they just
clicked because the expanded menu would not fit entirely on the page.
With this commit, the active menu entry is scrolled into view each time
the page is reloaded.
The previous behavior was also the reason for expanding the top menu
entries on only the homepage. Thanks to the scroll, they now always
expand.
Part-of: odoo/documentation#3275
Instead of redefining font-weights, we override the BS variables and add
one extra font-weight in the newly-introduced extended utilities file.
After this change all the variables needed replacing and some tweaking
was needed to get the same or closely similar result as before this
change.
By doing so the font-weight classes in the typography file were obsolete
and hence removed.
Some other font-weight issues which were already there have been fixed
in this commit too.
The aim of this cleanup is to use as many bootstrap classes, functions
and utilities as possible to reduce the amount of extra code.
Instead of redefining variables, BS variables are overridden in the
bootstrap_overridden file.
In order to be able to reuse these overridden variables within our own
custom variable file — and after consultation with SRI — it was
determined that the variables.scss file should come after the bootstrap
files in the order of importation, unlike the order of odoo website's
scss files.
Changes to variables in bootstrap_overridden have been made to adapt to
the new structure.
CSS variables avoid having to repeat code for each alert type.
Also remove the need to add "tip" to the theme-colors (no need for "tip"
styled buttons, badges etc, especially as tips use the primary color) by
styling `.alert-tip` with customized copy of BS alert mechanism.
In order to be able to modify the icons with a CSS variable,
the `content` attribute has been removed from the `o-inline-icon` mixin.
Code where this mixin is called in other places has been adapted.
Note: Some code is commented instead of being deleted.
This allows us to keep track of what should be commented out in future
versions of Sphinx' basic CSS.
