Commit Graph

106 Commits

Author SHA1 Message Date
Elisabeth Dickinson
bceba8c55d [IMP][CSS] Improve margins on headings and sections 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson
e36bd9b924 [IMP][CSS] Replace margin and padding values with variables 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson
8febda41af [IMP][CSS] Revamp modal to use all BS classes and variables 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson
3146d394c4 [IMP][CSS] Rescale heading fonts 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson
559d542a0d [IMP][CSS] Cleanup font variables 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson
ff2b57a127 [IMP][CSS] Cleanup admonitions (alerts) 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson
6e36a01099 [IMP][CSS] Cleanup color variables 2023-01-05 09:48:41 +01:00
Elisabeth Dickinson
e342ffb989 [IMP][CSS] update literals styles (.o_code, .sig-*) 2023-01-05 09:48:41 +01:00
Antoine Vandevenne (anv)
7b0b941b97 [IMP] odoo_theme: add the class o_code on literals
The SCSS that styles the `literal`, `code`, `file`, and `command` roles
is excessively complex because the traduction from RST to HTML is not
consistent from one role to another: some use `<code>` elements, some
have the `code` class, some wrap the literal with a `span` element.

This commit sets the `o_code` class on all of these roles' parent node
at translation time to allow simplifying the SCSS target.
2023-01-05 09:48:41 +01:00
Antoine Vandevenne (anv)
b16202dcde [FIX] odoo_theme: handle non-TOC pages when expanding top menu entries
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`.

closes odoo/documentation#3263

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-01-03 19:07:05 +01:00
Antoine Vandevenne (anv)
da19dab578 [IMP] odoo_theme: scroll the active menu entry into view
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#3263
2023-01-03 19:07:05 +01:00
Antoine Vandevenne (anv)
b1efc8aad2 [FIX] odoo_theme: update the aria attributes when scrolling the page TOC
The 'aria-expanded' attribute was not correctly updated on the `i` tag
when the user scrolled through the page TOC. This caused a minor issue
where an arrow (`i`) that was collapsed manually with a click would no
longer automatically expand afterward.

task-3106339

closes odoo/documentation#3238

X-original-commit: f068065d39
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-27 13:10:41 +01:00
Antoine Vandevenne (anv)
899479c18d [IMP] odoo_theme: expand top level menu items on the homepage
When the user browses the homepage, it might be hard to figure out
where they want to go next. Expanding the top-level menu items could
help them with that.

task-3106339

X-original-commit: 5526f1ea07
Part-of: odoo/documentation#3238
2022-12-27 13:10:41 +01:00
Morgane (morm)
a52a9eef2d [IMP] documentation: legal page design
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

closes odoo/documentation#3136

X-original-commit: d7b69d802a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-07 18:44:34 +01:00
Morgane (morm)
898fdf15ae [FIX] documentation: tabs responsiveness
Prior of this commit, the tabs were not responsive in the documentation

closes odoo/documentation#3080

X-original-commit: c9a001d22b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-12-06 14:37:03 +01:00
Victor Feyens
c367974170 [FIX] *: remove trailing whitespaces
Part-of: odoo/documentation#2983
2022-11-18 20:30:01 +01:00
Victor Feyens
968ed0a17a [FIX] *: enforce 1 newline on files end
Part-of: odoo/documentation#2983
2022-11-18 20:30:00 +01:00
Victor Feyens
31f9b8a56d [CLN] core: upgrade to python 3.6
& sort imports

closes odoo/documentation#2975

X-original-commit: 57784a2f90
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-11-17 17:20:55 +01:00
Antoine Vandevenne (anv)
cdb4b9398c [IMP] extensions/spoilers: add an extension for spoilers
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

closes odoo/documentation#2876

X-original-commit: 4d7a88639a
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>
2022-10-28 15:51:21 +02:00
stefanorigano (SRI)
9b695ca9c3 [IMP] odoo_theme: add default BS functions
Prior to this change it was not possible to use Bootstrap default SCSS
functions in 'bootstrap_overridden.scss'.

This commit mirrors odoo framework's architecture, injecting bootstrap
'_functions.scss' at the beginning of the documentation's SCSS "bundle".

Commit preparatory to the introduction of the 'Spoiler' documentation
component.

task-3036845

X-original-commit: 1691e8970b
Part-of: odoo/documentation#2876
2022-10-28 15:51:20 +02:00
Victor Feyens
fb149f3cb3 [IMP] conf.py, requirements.txt, *: allow building with Python 3.10
- 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

Part-of: odoo/documentation#2455
2022-07-14 16:42:08 +02:00
Antoine Vandevenne (anv)
61e94177f6 [FIX] odoo_theme: show a cursor when hovering on an image without modal
The images that have the class `o-no-modal` cannot be clicked to open in
a modal, so the cursor should not be changed to a pointer when hovering
on them.

This commit also simplifies the theme's SCSS by replacing the hard-coded
SVG images used in the "Supported versions" page by unicode circles with
a custom styling.

X-original-commit: f648960c78
Part-of: odoo/documentation#2467
Co-authored-by: Elisabeth Dickinson (edi) <edi@odoo.com>
2022-07-13 19:56:04 +02:00
Antoine Vandevenne (anv)
9b54acbee1 [FIX] odoo_theme: only open images that have no target in modal
Since clicking on the image redirects the user to the target URL, it's
useless to open the image in a modal. Also, it partially broke the
layout of the /legal.html page due to the modal div being inserted into
table cells.

This commit also introduces the possibility to add the `o-no-modal`
class on images that should not open in a modal.

task-2909167

X-original-commit: 7cbbb77746
Part-of: odoo/documentation#2467
2022-07-13 19:56:03 +02:00
Antoine Vandevenne (anv)
49387a9557 [FIX] odoo_theme: fix the display of modal images in mobile
task-2908330

closes odoo/documentation#2452

X-original-commit: 5e0f14f683
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-12 18:31:45 +02:00
Antoine Vandevenne (anv)
cb8d65d5e3 [MOV] developer/misc: move all pages to a more logical location
Before this commit, the "Developer/Misc" directory of the doc, and
more particularly the "Developer/Misc/Other" sub-directory, was used as
a garbage dump where we moved all the pages that didn't fit elsewhere.
Due to that, interesting and important pages, such as the Coding
Guidelines, were buried in that directory never to be read again by Odoo
developers.

This commit moves most pages under "Misc" one or two levels up to be
located directly under "Developer" hence making them more accessible. A
new "Contributing/Development" directory is added to host the Coding
Guidelines page and soon many other pages.

task-2897143

closes odoo/documentation#2381

X-original-commit: 12ff9f118b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-07-04 17:47:43 +02:00
Antoine Vandevenne (anv)
c24673d532 [IMP] developer/views: apply the new API references style
The documentation of view attributes was lacking visual structure to
help the reader figure out which attribute relates to which parent
element. Since this documentation was relying on RST block quotes to
represent the hierarchy of view attributes, we can apply the same new
styling that was added with commit 934f45cf and designed for autodoc,
and which relies on the exact same HTML structure as block quotes.

task-2755298

closes odoo/documentation#2342

X-original-commit: e2a3ca0631
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-29 11:11:49 +02:00
Elisabeth Dickinson
19f90800c3 [REF] odoo_theme: replace values with variables in SCSS files
X-original-commit: c82d95b17c
2022-06-27 16:04:59 +02:00
Elisabeth Dickinson
5c344d726f [REF] odoo_theme: move stray mixins into the _mixins.scss file
X-original-commit: 7fa153594d
2022-06-27 16:04:58 +02:00
Elisabeth Dickinson
3be8b18bee [CLN] odoo_theme: remove unnecessary css
X-original-commit: fca78f44db
2022-06-27 16:04:58 +02:00
Elisabeth Dickinson
52ee4a7a9c [CLN] odoo_theme: remove old doc's unused variables
X-original-commit: 383e3d4206
2022-06-27 16:04:57 +02:00
Elisabeth Dickinson
974bc9624a [REF] odoo_theme: move scrollbar styling to .o_side_nav-inner
X-original-commit: b9ca38215d
2022-06-27 16:04:56 +02:00
Elisabeth Dickinson
7c37474507 [CLN] odoo_theme: remove old doc's utility mixins
These mixins were used in the old doc and were kept "just in case". The
`valid-radius` mixin already exists in the bootstrap library.

X-original-commit: 9a2e8eefef
2022-06-27 16:04:55 +02:00
Elisabeth Dickinson
b103c3fbbd [IMP] odoo_theme: replace "hide search matches" by a close button
X-original-commit: 994d273a59
2022-06-27 16:04:54 +02:00
Elisabeth Dickinson
cc61e7ff93 [IMP] odoo_theme: improve spacing around code blocks on reference pages
X-original-commit: 794e42f78b
2022-06-27 16:04:53 +02:00
Elisabeth Dickinson
aee958b1ff [FIX] odoo_theme: fix scrollTo margin/padding with new headers height
The scroll padding needed increasing with the new sub-header.
Unnecessary calc() and parenthesis on the headers-height variable are
removed.

X-original-commit: 0b536debac
2022-06-27 16:04:52 +02:00
Elisabeth Dickinson
c366745863 [FIX] odoo_theme: remove the horizontal scroll bar
X-original-commit: 26bc1cd707
2022-06-27 16:04:51 +02:00
Elisabeth Dickinson
568b75790b [IMP] odoo_theme: improve URL stylings
- Remove external-link icon on images.
- Remove underline from external-link icon on link hover.
- Add overflow-wrap on URLs on mobile.

X-original-commit: 91cb3ca026
2022-06-27 16:04:50 +02:00
Elisabeth Dickinson
cfa9494c33 [IMP] odoo_theme: improve general spacings and paddings
X-original-commit: 2e693b3c4a
2022-06-27 16:04:49 +02:00
Elisabeth Dickinson
fe0211c1ed [IMP] odoo_theme: improve special terms styling
Including the `:command:`, `:file:` and `:dfn:` roles, and code-styled
text in alerts.

task-2790284

X-original-commit: 7239986484
2022-06-27 16:04:48 +02:00
Antoine Vandevenne (anv)
302b5307fa [IMP] redirects: split redirects.txt into multiple, per-version, files
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

closes odoo/documentation#2292

X-original-commit: 0417b95514
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-24 10:29:43 +02:00
Antoine Vandevenne (anv)
bc91b1d06c [IMP] odoo_theme: open images in a modal
task-2358082

closes odoo/documentation#2284

X-original-commit: 2a867b4f60
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Elisabeth Dickinson (edi) <edi@odoo.com>
2022-06-23 20:37:42 +02:00
Antoine Vandevenne (anv)
b3f26c2914 [FIX] odoo_theme: correctly test for fallback URLs when using switchers
closes odoo/documentation#2275

X-original-commit: 9e84b6f681
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-23 10:15:03 +02:00
Elisabeth Dickinson
f47fda5471 [FIX] odoo_theme: fix highlight blocks in field-list items
On pages such as /developer/reference/backend/orm.html#fields, the
highlight blocks inside `dl.field-list` items were pushing the width of
the page to go outside the screen on mobile. This is fixed by changing
the `.field-list`'s `display: grid` into `block` on mobile.

closes odoo/documentation#2230

X-original-commit: a689ea236d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-15 17:19:01 +02:00
Antoine Vandevenne (anv)
c952b418f2 [FIX] odoo_theme: stop testing for valid URLs if in localhost
The mechanism that makes the version and language switchers test for
valid URLs crashed when testing in localhost. The mechanism is now
skipped if the URL starts with a '/'.

X-original-commit: 98e98f65c9
2022-06-15 11:49:32 +02:00
Elisabeth Dickinson
311752091d [FIX] odoo_theme: fix searchbox's highlight-link
task-2800937

X-original-commit: 3fd32fe92a
2022-06-15 11:49:31 +02:00
Elisabeth Dickinson
522f684b9a [IMP] odoo_theme: revamp side menu to add overlay
task-2800937

X-original-commit: 4ed8c2238a
2022-06-15 11:49:30 +02:00
Elisabeth Dickinson
7fe67ec854 [FIX] odoo_theme: fix menu scrolling
task-2800937

X-original-commit: 9c53901db9
2022-06-15 11:49:29 +02:00
Elisabeth Dickinson
b49110f30e [IMP] odoo_theme: add side menu collapse icon
task-2800937

X-original-commit: 7284b11a36
2022-06-15 11:49:28 +02:00
Elisabeth Dickinson
1b8d66916a [IMP] odoo_theme: change collapsing menu orientation
task-2800937

X-original-commit: dee96ad2da
2022-06-15 11:49:27 +02:00
Elisabeth Dickinson
e0a4defc84 [IMP] odoo_theme: add subheader and adapt switchers and searchbar
task-2800937

X-original-commit: 411e1cb1d3
2022-06-15 11:49:26 +02:00