Commit Graph

64 Commits

Author SHA1 Message Date
Antoine Vandevenne (anv)
44a025babf [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:27:18 +02:00
Elisabeth Dickinson
ac3b5349f9 [FIX] odoo_theme: fix searchbox's highlight-link
task-2800937

X-original-commit: 3fd32fe92a
2022-06-15 11:27:17 +02:00
Elisabeth Dickinson
532992084d [IMP] odoo_theme: revamp side menu to add overlay
task-2800937

X-original-commit: 4ed8c2238a
2022-06-15 11:27:16 +02:00
Elisabeth Dickinson
e1504aac49 [FIX] odoo_theme: fix menu scrolling
task-2800937

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

X-original-commit: 7284b11a36
2022-06-15 11:27:14 +02:00
Elisabeth Dickinson
315f1a1a26 [IMP] odoo_theme: change collapsing menu orientation
task-2800937

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

X-original-commit: 411e1cb1d3
2022-06-15 11:27:12 +02:00
Elisabeth Dickinson
4e8fc887db [IMP] design: add an icon behind external links
The external links' target attribute is now also updated to open the
link in a new tab. In addition, the "[source]" link of autodoc's models
is moved right next to the name of the model to correctly position the
icon.

task-2790244

closes odoo/documentation#2208

X-original-commit: 343decf192
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-14 15:28:11 +02:00
Elisabeth Dickinson
07e943f85c [IMP] odoo_theme: show the "On this page" section in mobile
When the page gets too small for the "On this page" section (local tree
of content) to fit on the page, the section is now moved above the menu
(global tree of content) rather than being hidden.

task-2800970

closes odoo/documentation#2194

X-original-commit: c0040fa532
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-14 07:42:03 +02:00
Antoine Vandevenne (anv)
c8e9d82884 [FIX] homepage: fix the link to the external API page
The page was moved from odoo.rst to external_api.rst with commit
0fc52188.

task-2870501

closes odoo/documentation#2139

X-original-commit: f6cd947d6b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-06-02 13:13:09 +02:00
Martin Trigaux
fbb1cfc90f [FIX] odoo_theme: correctly consider baseurl
urlBase was only containing the domain name, not the /documentation/

closes odoo/documentation#2058

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-20 11:56:45 +02:00
Martin Trigaux
7c2f300c95 [IMP] odoo_theme: introduce fallback URLs for the page switchers
When a user clicks on the link of an alternate page in the version or
language switcher, we now check if the page referenced by the target URL
exists or not. If not, we generate a series of fallback URLs from the
target URL and check whether the targeted resource exists or not, until
we read the root of the documentation. As soon as we find a valid URL,
we redirect the user to it.

This is inspired by the behaviour of docs.python.org's version and
language switchers.

task-2534669

closes odoo/documentation#2044

X-original-commit: 25e863a64c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 22:32:45 +02:00
Jeremy Kersten
8df7aa1d3e [IMP] odoo_theme: allow to add plausible script
export PLAUSIBLE_SCRIPT=https://plausible.io/js/script.js
export PLAUSIBLE_DOMAIN=yourdomain.com

closes odoo/documentation#1951

X-original-commit: 4c526eb02f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Jérémy Kersten <jke@odoo.com>
2022-05-09 11:44:17 +02:00
wan
c4b09dfbd9 [ADD] extension: allow to build graphs using graphviz
Part-of: odoo/documentation#1334
2022-05-06 17:47:11 +02:00
wan
3d358fdbcd [ADD] extensions: new autofield directive
This new directive is generating documentation from Odoo fields. This
can be used to build documentation about business classes.
This will help developpers import/export data and build localization
modules for instance.

Part-of: odoo/documentation#1334
2022-05-06 17:47:11 +02:00
Antoine Vandevenne (anv)
fbe363ad8c [IMP] odoo_theme: hide the "Edit on GitHub" button for pages in legal/
closes odoo/documentation#1812

X-original-commit: ff79ca3a6b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-08 15:39:50 +02:00
Donatienne Pirlot
24e7e73154 [FIX] upgrade: small fixes
task-2684744

closes odoo/documentation#1766

X-original-commit: 6a316ca86e
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-03-29 11:28:48 +02:00
Antoine Vandevenne (anv)
943251b295 [FIX] odoo_theme: fix CSS issues and warnings
closes odoo/documentation#1714

X-original-commit: cb7a41b75b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-18 16:59:25 +01:00
Antoine Vandevenne (anv)
30b9f172c5 [REM] extensions: remove the 'switcher' extension
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

X-original-commit: 269173caac
Part-of: odoo/documentation#1689
2022-03-11 14:45:06 +00:00
Elisabeth Dickinson
00eded4e42 [IMP] scss: content tabs refining
This commit removes unnecessary negative margins and makes code-blocks
inside content tabs lose their bottom margin and border.

closes odoo/documentation#1670

X-original-commit: ac28acee4a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-08 16:31:26 +00:00
Elisabeth Dickinson
238444ece0 [IMP] scss: make alert full width of parent
Before this commit, the alerts would all have different widths according
to their content, some stretching and getting pushed under the
"on this page" menu. This way all alerts are aligned.

X-original-commit: b76a566522
Part-of: odoo/documentation#1670
2022-03-08 16:31:26 +00:00
Carlos Valverde
fa3ed32409 [IMP] documentation: content tabs design
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

closes odoo/documentation#1663

X-original-commit: 7250f88b8d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-03-08 10:16:59 +00:00
Antoine Vandevenne (anv)
69ff7243bf [IMP] extensions: add content tabs (backport of cf6ca0fb)
closes odoo/documentation#1626

X-original-commit: 286b01a241
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-23 13:55:08 +00:00
Elisabeth Dickinson
6e17f7a40b [IMP] odoo_theme: switch admonitions' display type to inline-block
When placing an image before an admonition block and setting its
alignment to left or right, the admonition block would hide the image.
The reason for this is the use of "float" on the image. In order for
the image to reappear, we change the admonition's `display: block` to
`display: inline-block`.

task-2582954

closes odoo/documentation#1592

X-original-commit: c30f2735b8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-15 08:49:24 +00:00
Antoine Vandevenne (anv)
837ee962c2 [IMP] conf: show all relevant versions in the version switcher
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.

closes odoo/documentation#1578

X-original-commit: fb469b8211
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-02-11 14:29:57 +00:00
wan
434bb66492 [ADD] extensions: add a custom example admonition
closes odoo/documentation#1503

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-01-28 11:05:14 +00:00
Géry Debongnie
a76e505892 [IMP] developer: rename addons/js => backend/frontend
The terminology did not really make sense for a lot of these sub pages.
This change should have been done long ago, but was probably delayed
because some people in Odoo call the web client the "backend", which is
really misleading.

This commit also renames the title "Reference Guides" to "Reference",
since this section does not contain any guides anyway.

Part-of: odoo/documentation#1243
2021-11-02 13:42:38 +00:00
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
Martin Trigaux
192d9349c1 [MERFE] Froward port of 13.0 to 14.0 2021-06-14 16:11:22 +02:00
Martin Trigaux
c38dbf59ce [MERGE] Forward port of 12.0 into 13.0 2021-06-14 16:04:49 +02:00
Martin Trigaux
207bfd6684 [IMP] extension: mark HTML content as translatable 2021-06-14 15:01:01 +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
Elisabeth Dickinson
c8750ae032
[FIX] odoo_theme: fix header display on small screen widths
The highlight-link was pushing the header height to be on two lines.
It is now absolutely positioned below the searchbar instead of to its right.
The switchers now push themselves to the right instead of being pushed by the searchbar-wrapper.
2021-06-09 11:22:58 +02:00
Antoine Vandevenne (anv)
5469c2fb2c [MERGE] Forward-port of branch 13.0 to 14.0 2021-06-07 09:15:53 +02:00
Antoine Vandevenne (anv)
a8cfd6c6c5 [MERGE] Forward-port of branch 12.0 to 13.0 2021-06-07 09:09:43 +02:00
Antoine Vandevenne (anv)
10e0a48ac0 [IMP] contributing: flatten hierarchy of "documentation" pages
The content of the introduction guide is moved to the parent page which
is itself renamed to "Write documentation". The homepage's quick links
are adapted accordingly.

The chance is also taken to move media files in the appropriate folder.

task-2558998
2021-06-04 17:44:23 +02:00
Elisabeth Dickinson
49baf6b4d7
[IMP] odoo_theme: fix layout on esoteric screens 2021-06-04 17:27:11 +02:00
Antoine Vandevenne (anv)
2591ddc6d2 [FIX] odoo_theme: fix crash on menu loading introduced with 675f7bc8 2021-06-04 16:24:58 +02:00
Antoine Vandevenne (anv)
675f7bc899 [FIX] odoo_theme: highlight all occurrences of a same entry in the menu
When a page is referenced multiple times in the global toctree, only its
latest TOC entry was highlighted (and expanded if it's a TOC page).
This commit allows a page to be referenced multiple times at any level
of the global TOC while correctly highlighting all of its TOC entries.

task-2551473
2021-06-04 11:44:03 +02:00
Elisabeth Dickinson
7efbf490f6 [FIX] odoo_theme: padding fix in sidenav 2021-05-31 16:04:41 +02:00
Victor Feyens
a1e7024fa0 [MERGE] Forward-port of branch 13.0 to 14.0 2021-05-31 15:16:09 +02:00
Victor Feyens
40afc9d9f0 [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-31 14:54:23 +02:00
Victor Feyens
bfec9a58f9 [FIX] code: typos 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
Elisabeth Dickinson
fa267e5cfc [FIX] odoo_theme: design fixes
- change button color (in line with odoo.com)
- adapt margin above h2
- change gray variable on footer (to use the same as everywhere else)
- fix grey background in nav
- fix opacity on icon when active in nav
- add icons on mobile homepage
- fix missing homepage separator in mobile
- fix nav top padding on mobile (hidden by searchbar)
- adjust nav's active links styles
- adjust margin on version switcher
- hide toctree-wrapper when show-content is in meta
- fix highlighted-link on tablet screen
- style toctree-wrapper (a lil bit)
- hide local toc while page is loading
- SCSS linting
2021-05-28 17:06:58 +02:00
Elisabeth Dickinson
74e7da5694 [FIX] odoo_theme: hide searchbar on scroll in mobile 2021-05-26 17:38:29 +02:00
Elisabeth Dickinson
88f00fe611
[FIX] odoo_theme: remove images from homepage
task-2534617
2021-05-26 11:40:14 +02:00