
Prior to this commit, the Odoo documentation was mainly split between two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...). This was causing several problems among which: - The theme, config, Makefile, and similar technical resources had to be duplicated. This resulted in inconsistent layout, features, and build environments from one documentation to another. - Some pages did not fit either documentation as they were relevant for both users and developers. Some were relevant to neither of the two (e.g., DB management). - Cross-doc references had to be absolute links and they broke often. - Merging large image files in the developer documentation would bloat the odoo/odoo repository. Some contributions had to be lightened to avoid merging too many images (e.g., Odoo development tutorials). - Long-time contributors to the user documentation were chilly about going through the merging process of the developer documentation because of the runbot, mergebot, `odoo-dev` repository, etc. - Some contributors would look for the developer documentation in the `odoo/documentation-user` repository. - Community issues about the user documentation were submitted on the `odoo/odoo` repository and vice-versa. Merging all documentations in one repository will allow us to have one place, one theme, one work process, and one set of tools (build environment, ...) for all of the Odoo docs. As this is a good opportunity to revamp the layout of the documentation, a brand new theme replaces the old one. It features a new way to navigate the documentation, centered on the idea of always letting the reader know what is the context (enclosing section, child pages, page structure ...) of the page they are reading. The previous theme would quickly confuse readers as they navigated the documentation and followed cross-application links. The chance is also taken to get rid of all the technical dangling parts, performance issues, and left-overs. Except for some page-specific JS scripts, the Odoo theme Sphinx extension is re-written from scratch based on the latest Sphinx release to benefit from the improvements and ease future contributions. task-2351938 task-2352371 task-2205684 task-2352544 Closes #945
224 lines
5.3 KiB
SCSS
224 lines
5.3 KiB
SCSS
// Notes on the classes:
|
|
//
|
|
// 1. .carousel.pointer-event should ideally be pan-y (to allow for users to scroll vertically)
|
|
// even when their scroll action started on a carousel, but for compatibility (with Firefox)
|
|
// we're preventing all actions instead
|
|
// 2. The .carousel-item-start and .carousel-item-end is used to indicate where
|
|
// the active slide is heading.
|
|
// 3. .active.carousel-item is the current slide.
|
|
// 4. .active.carousel-item-start and .active.carousel-item-end is the current
|
|
// slide in its in-transition state. Only one of these occurs at a time.
|
|
// 5. .carousel-item-next.carousel-item-start and .carousel-item-prev.carousel-item-end
|
|
// is the upcoming slide in transition.
|
|
|
|
.carousel {
|
|
position: relative;
|
|
}
|
|
|
|
.carousel.pointer-event {
|
|
touch-action: pan-y;
|
|
}
|
|
|
|
.carousel-inner {
|
|
position: relative;
|
|
width: 100%;
|
|
overflow: hidden;
|
|
@include clearfix();
|
|
}
|
|
|
|
.carousel-item {
|
|
position: relative;
|
|
display: none;
|
|
float: left;
|
|
width: 100%;
|
|
margin-right: -100%;
|
|
backface-visibility: hidden;
|
|
@include transition($carousel-transition);
|
|
}
|
|
|
|
.carousel-item.active,
|
|
.carousel-item-next,
|
|
.carousel-item-prev {
|
|
display: block;
|
|
}
|
|
|
|
/* rtl:begin:ignore */
|
|
.carousel-item-next:not(.carousel-item-start),
|
|
.active.carousel-item-end {
|
|
transform: translateX(100%);
|
|
}
|
|
|
|
.carousel-item-prev:not(.carousel-item-end),
|
|
.active.carousel-item-start {
|
|
transform: translateX(-100%);
|
|
}
|
|
|
|
/* rtl:end:ignore */
|
|
|
|
|
|
//
|
|
// Alternate transitions
|
|
//
|
|
|
|
.carousel-fade {
|
|
.carousel-item {
|
|
opacity: 0;
|
|
transition-property: opacity;
|
|
transform: none;
|
|
}
|
|
|
|
.carousel-item.active,
|
|
.carousel-item-next.carousel-item-start,
|
|
.carousel-item-prev.carousel-item-end {
|
|
z-index: 1;
|
|
opacity: 1;
|
|
}
|
|
|
|
.active.carousel-item-start,
|
|
.active.carousel-item-end {
|
|
z-index: 0;
|
|
opacity: 0;
|
|
@include transition(opacity 0s $carousel-transition-duration);
|
|
}
|
|
}
|
|
|
|
|
|
//
|
|
// Left/right controls for nav
|
|
//
|
|
|
|
.carousel-control-prev,
|
|
.carousel-control-next {
|
|
position: absolute;
|
|
top: 0;
|
|
bottom: 0;
|
|
z-index: 1;
|
|
// Use flex for alignment (1-3)
|
|
display: flex; // 1. allow flex styles
|
|
align-items: center; // 2. vertically center contents
|
|
justify-content: center; // 3. horizontally center contents
|
|
width: $carousel-control-width;
|
|
color: $carousel-control-color;
|
|
text-align: center;
|
|
opacity: $carousel-control-opacity;
|
|
@include transition($carousel-control-transition);
|
|
|
|
// Hover/focus state
|
|
&:hover,
|
|
&:focus {
|
|
color: $carousel-control-color;
|
|
text-decoration: none;
|
|
outline: 0;
|
|
opacity: $carousel-control-hover-opacity;
|
|
}
|
|
}
|
|
.carousel-control-prev {
|
|
left: 0;
|
|
background-image: if($enable-gradients, linear-gradient(90deg, rgba($black, .25), rgba($black, .001)), null);
|
|
}
|
|
.carousel-control-next {
|
|
right: 0;
|
|
background-image: if($enable-gradients, linear-gradient(270deg, rgba($black, .25), rgba($black, .001)), null);
|
|
}
|
|
|
|
// Icons for within
|
|
.carousel-control-prev-icon,
|
|
.carousel-control-next-icon {
|
|
display: inline-block;
|
|
width: $carousel-control-icon-width;
|
|
height: $carousel-control-icon-width;
|
|
background-repeat: no-repeat;
|
|
background-position: 50%;
|
|
background-size: 100% 100%;
|
|
}
|
|
|
|
/* rtl:options: {
|
|
"autoRename": true,
|
|
"stringMap":[ {
|
|
"name" : "prev-next",
|
|
"search" : "prev",
|
|
"replace" : "next"
|
|
} ]
|
|
} */
|
|
.carousel-control-prev-icon {
|
|
background-image: escape-svg($carousel-control-prev-icon-bg);
|
|
}
|
|
.carousel-control-next-icon {
|
|
background-image: escape-svg($carousel-control-next-icon-bg);
|
|
}
|
|
|
|
// Optional indicator pips
|
|
//
|
|
// Add an ordered list with the following class and add a list item for each
|
|
// slide your carousel holds.
|
|
|
|
.carousel-indicators {
|
|
position: absolute;
|
|
right: 0;
|
|
bottom: 0;
|
|
left: 0;
|
|
z-index: 2;
|
|
display: flex;
|
|
justify-content: center;
|
|
padding-left: 0; // override <ol> default
|
|
// Use the .carousel-control's width as margin so we don't overlay those
|
|
margin-right: $carousel-control-width;
|
|
margin-left: $carousel-control-width;
|
|
list-style: none;
|
|
|
|
li {
|
|
box-sizing: content-box;
|
|
flex: 0 1 auto;
|
|
width: $carousel-indicator-width;
|
|
height: $carousel-indicator-height;
|
|
margin-right: $carousel-indicator-spacer;
|
|
margin-left: $carousel-indicator-spacer;
|
|
text-indent: -999px;
|
|
cursor: pointer;
|
|
background-color: $carousel-indicator-active-bg;
|
|
background-clip: padding-box;
|
|
// Use transparent borders to increase the hit area by 10px on top and bottom.
|
|
border-top: $carousel-indicator-hit-area-height solid transparent;
|
|
border-bottom: $carousel-indicator-hit-area-height solid transparent;
|
|
opacity: $carousel-indicator-opacity;
|
|
@include transition($carousel-indicator-transition);
|
|
}
|
|
|
|
.active {
|
|
opacity: $carousel-indicator-active-opacity;
|
|
}
|
|
}
|
|
|
|
|
|
// Optional captions
|
|
//
|
|
//
|
|
|
|
.carousel-caption {
|
|
position: absolute;
|
|
right: (100% - $carousel-caption-width) / 2;
|
|
bottom: $carousel-caption-spacer;
|
|
left: (100% - $carousel-caption-width) / 2;
|
|
padding-top: $carousel-caption-padding-y;
|
|
padding-bottom: $carousel-caption-padding-y;
|
|
color: $carousel-caption-color;
|
|
text-align: center;
|
|
}
|
|
|
|
// Dark mode carousel
|
|
|
|
.carousel-dark {
|
|
.carousel-control-prev-icon,
|
|
.carousel-control-next-icon {
|
|
filter: $carousel-dark-control-icon-filter;
|
|
}
|
|
|
|
.carousel-indicators li {
|
|
background-color: $carousel-dark-indicator-active-bg;
|
|
}
|
|
|
|
.carousel-caption {
|
|
color: $carousel-dark-caption-color;
|
|
}
|
|
}
|