e3fee2cf46
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
788 lines
12 KiB
SCSS
788 lines
12 KiB
SCSS
/*
|
|
* basic.css
|
|
* ~~~~~~~~~
|
|
*
|
|
* Sphinx stylesheet -- basic theme.
|
|
*
|
|
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
|
|
* :license: BSD, see LICENSE for details.
|
|
*
|
|
*/
|
|
|
|
/* -- main layout ----------------------------------------------------------- */
|
|
|
|
div.clearer {
|
|
clear: both;
|
|
}
|
|
|
|
div.section::after {
|
|
display: block;
|
|
content: '';
|
|
clear: left;
|
|
}
|
|
|
|
/* -- relbar ---------------------------------------------------------------- */
|
|
/*
|
|
div.related {
|
|
width: 100%;
|
|
font-size: 90%;
|
|
}
|
|
|
|
div.related h3 {
|
|
display: none;
|
|
}
|
|
|
|
div.related ul {
|
|
margin: 0;
|
|
padding: 0 0 0 10px;
|
|
list-style: none;
|
|
}
|
|
|
|
div.related li {
|
|
display: inline;
|
|
}
|
|
|
|
div.related li.right {
|
|
float: right;
|
|
margin-right: 5px;
|
|
} */
|
|
|
|
/* -- search page ----------------------------------------------------------- */
|
|
|
|
ul.search {
|
|
margin: 10px 0 0 20px;
|
|
padding: 0;
|
|
}
|
|
|
|
/* ul.search li {
|
|
padding: 5px 0 5px 20px;
|
|
background-image: url(file.png);
|
|
background-repeat: no-repeat;
|
|
background-position: 0 7px;
|
|
} */
|
|
|
|
ul.search li a {
|
|
font-weight: bold;
|
|
}
|
|
|
|
ul.search li p.context {
|
|
color: #888;
|
|
margin: 2px 0 0 30px;
|
|
text-align: left;
|
|
}
|
|
|
|
ul.keywordmatches li.goodmatch a {
|
|
font-weight: bold;
|
|
}
|
|
|
|
/* -- index page ------------------------------------------------------------ */
|
|
|
|
table.contentstable {
|
|
width: 90%;
|
|
margin-left: auto;
|
|
margin-right: auto;
|
|
}
|
|
|
|
table.contentstable p.biglink {
|
|
line-height: 150%;
|
|
}
|
|
|
|
a.biglink {
|
|
font-size: 1.3em;
|
|
}
|
|
|
|
span.linkdescr {
|
|
font-style: italic;
|
|
padding-top: 5px;
|
|
font-size: 90%;
|
|
}
|
|
|
|
/* -- general index --------------------------------------------------------- */
|
|
|
|
table.indextable {
|
|
width: 100%;
|
|
}
|
|
|
|
table.indextable td {
|
|
text-align: left;
|
|
vertical-align: top;
|
|
}
|
|
|
|
table.indextable ul {
|
|
margin-top: 0;
|
|
margin-bottom: 0;
|
|
list-style-type: none;
|
|
}
|
|
|
|
table.indextable > tbody > tr > td > ul {
|
|
padding-left: 0em;
|
|
}
|
|
|
|
table.indextable tr.pcap {
|
|
height: 10px;
|
|
}
|
|
|
|
table.indextable tr.cap {
|
|
margin-top: 10px;
|
|
background-color: #f2f2f2;
|
|
}
|
|
|
|
img.toggler {
|
|
margin-right: 3px;
|
|
margin-top: 3px;
|
|
cursor: pointer;
|
|
}
|
|
|
|
div.modindex-jumpbox {
|
|
border-top: 1px solid #ddd;
|
|
border-bottom: 1px solid #ddd;
|
|
margin: 1em 0 1em 0;
|
|
padding: 0.4em;
|
|
}
|
|
|
|
div.genindex-jumpbox {
|
|
border-top: 1px solid #ddd;
|
|
border-bottom: 1px solid #ddd;
|
|
margin: 1em 0 1em 0;
|
|
padding: 0.4em;
|
|
}
|
|
|
|
/* -- domain module index --------------------------------------------------- */
|
|
|
|
table.modindextable td {
|
|
padding: 2px;
|
|
border-collapse: collapse;
|
|
}
|
|
|
|
/* -- general body styles --------------------------------------------------- */
|
|
|
|
/* div.body {
|
|
min-width: {{ theme_body_min_width|todim }};
|
|
max-width: {{ theme_body_max_width|todim }};
|
|
} */
|
|
|
|
div.body p, div.body dd, div.body li, div.body blockquote {
|
|
-moz-hyphens: auto;
|
|
-ms-hyphens: auto;
|
|
-webkit-hyphens: auto;
|
|
hyphens: auto;
|
|
}
|
|
|
|
|
|
a.brackets:before,
|
|
span.brackets > a:before{
|
|
content: "[";
|
|
}
|
|
|
|
a.brackets:after,
|
|
span.brackets > a:after {
|
|
content: "]";
|
|
}
|
|
|
|
h1:hover > a.headerlink,
|
|
h2:hover > a.headerlink,
|
|
h3:hover > a.headerlink,
|
|
h4:hover > a.headerlink,
|
|
h5:hover > a.headerlink,
|
|
h6:hover > a.headerlink,
|
|
dt:hover > a.headerlink,
|
|
caption:hover > a.headerlink,
|
|
p.caption:hover > a.headerlink,
|
|
div.code-block-caption:hover > a.headerlink {
|
|
visibility: visible;
|
|
}
|
|
|
|
div.body p.caption {
|
|
text-align: inherit;
|
|
}
|
|
|
|
div.body td {
|
|
text-align: left;
|
|
}
|
|
|
|
.first {
|
|
margin-top: 0 !important;
|
|
}
|
|
|
|
p.rubric {
|
|
font-weight: bold;
|
|
}
|
|
|
|
img.align-left, .figure.align-left, object.align-left {
|
|
clear: left;
|
|
float: left;
|
|
margin-right: 1em;
|
|
}
|
|
|
|
img.align-right, .figure.align-right, object.align-right {
|
|
clear: right;
|
|
float: right;
|
|
margin-left: 1em;
|
|
}
|
|
|
|
img.align-center, .figure.align-center, object.align-center {
|
|
display: block;
|
|
margin-left: auto;
|
|
margin-right: auto;
|
|
}
|
|
|
|
img.align-default, .figure.align-default {
|
|
display: block;
|
|
margin-left: auto;
|
|
margin-right: auto;
|
|
}
|
|
|
|
.align-left {
|
|
text-align: left;
|
|
}
|
|
|
|
.align-center {
|
|
text-align: center;
|
|
}
|
|
|
|
/* .align-default {
|
|
text-align: center;
|
|
} */
|
|
|
|
.align-right {
|
|
text-align: right;
|
|
}
|
|
|
|
/* -- sidebars -------------------------------------------------------------- */
|
|
|
|
div.sidebar {
|
|
margin: 0 0 0.5em 1em;
|
|
border: 1px solid #ddb;
|
|
padding: 7px;
|
|
background-color: #ffe;
|
|
width: 40%;
|
|
float: right;
|
|
clear: right;
|
|
overflow-x: auto;
|
|
}
|
|
|
|
p.sidebar-title {
|
|
font-weight: bold;
|
|
}
|
|
|
|
/* div.admonition, div.topic, blockquote {
|
|
clear: left;
|
|
} */
|
|
|
|
/* -- topics ---------------------------------------------------------------- */
|
|
|
|
div.topic {
|
|
border: 1px solid #ccc;
|
|
padding: 7px;
|
|
margin: 10px 0 10px 0;
|
|
}
|
|
|
|
p.topic-title {
|
|
font-size: 1.1em;
|
|
font-weight: bold;
|
|
margin-top: 10px;
|
|
}
|
|
|
|
/* -- admonitions ----------------------------------------------------------- */
|
|
|
|
div.admonition {
|
|
margin-top: 10px;
|
|
margin-bottom: 10px;
|
|
padding: 7px;
|
|
}
|
|
|
|
div.admonition dt {
|
|
font-weight: bold;
|
|
}
|
|
|
|
p.admonition-title {
|
|
margin: 0px 10px 5px 0px;
|
|
font-weight: bold;
|
|
}
|
|
|
|
div.body p.centered {
|
|
text-align: center;
|
|
margin-top: 25px;
|
|
}
|
|
|
|
/* -- content of sidebars/topics/admonitions -------------------------------- */
|
|
|
|
/* div.sidebar > :last-child,
|
|
div.topic > :last-child,
|
|
div.admonition > :last-child {
|
|
margin-bottom: 0;
|
|
} */
|
|
|
|
/* div.sidebar::after,
|
|
div.topic::after,
|
|
div.admonition::after,
|
|
blockquote::after {
|
|
display: block;
|
|
content: '';
|
|
clear: both;
|
|
} */
|
|
|
|
/* -- tables ---------------------------------------------------------------- */
|
|
|
|
/* table.docutils {
|
|
margin-top: 10px;
|
|
margin-bottom: 10px;
|
|
border: 0;
|
|
border-collapse: collapse;
|
|
} */
|
|
|
|
table.align-center {
|
|
margin-left: auto;
|
|
margin-right: auto;
|
|
}
|
|
|
|
table.align-default {
|
|
margin-left: auto;
|
|
margin-right: auto;
|
|
}
|
|
|
|
table caption span.caption-number {
|
|
font-style: italic;
|
|
}
|
|
|
|
table caption span.caption-text {
|
|
}
|
|
|
|
/* table.docutils td, table.docutils th {
|
|
padding: 1px 8px 1px 5px;
|
|
border-top: 0;
|
|
border-left: 0;
|
|
border-right: 0;
|
|
border-bottom: 1px solid #aaa;
|
|
} */
|
|
|
|
table.footnote td, table.footnote th {
|
|
border: 0 !important;
|
|
}
|
|
|
|
th {
|
|
text-align: left;
|
|
padding-right: 5px;
|
|
}
|
|
|
|
table.citation {
|
|
border-left: solid 1px gray;
|
|
margin-left: 1px;
|
|
}
|
|
|
|
table.citation td {
|
|
border-bottom: none;
|
|
}
|
|
|
|
th > :first-child,
|
|
td > :first-child {
|
|
margin-top: 0px;
|
|
}
|
|
|
|
th > :last-child,
|
|
td > :last-child {
|
|
margin-bottom: 0px;
|
|
}
|
|
|
|
/* -- figures --------------------------------------------------------------- */
|
|
|
|
div.figure {
|
|
margin: 0.5em;
|
|
padding: 0.5em;
|
|
}
|
|
|
|
/* div.figure p.caption {
|
|
padding: 0.3em;
|
|
} */
|
|
|
|
div.figure p.caption span.caption-number {
|
|
font-style: italic;
|
|
}
|
|
|
|
div.figure p.caption span.caption-text {
|
|
}
|
|
|
|
/* -- field list styles ----------------------------------------------------- */
|
|
|
|
table.field-list td, table.field-list th {
|
|
border: 0 !important;
|
|
}
|
|
|
|
.field-list ul {
|
|
margin: 0;
|
|
padding-left: 1em;
|
|
}
|
|
|
|
.field-list p {
|
|
margin: 0;
|
|
}
|
|
|
|
.field-name {
|
|
-moz-hyphens: manual;
|
|
-ms-hyphens: manual;
|
|
-webkit-hyphens: manual;
|
|
hyphens: manual;
|
|
}
|
|
|
|
/* -- hlist styles ---------------------------------------------------------- */
|
|
|
|
table.hlist {
|
|
margin: 1em 0;
|
|
}
|
|
|
|
table.hlist td {
|
|
vertical-align: top;
|
|
}
|
|
|
|
|
|
/* -- other body styles ----------------------------------------------------- */
|
|
|
|
ol.arabic {
|
|
list-style: decimal;
|
|
}
|
|
|
|
ol.loweralpha {
|
|
list-style: lower-alpha;
|
|
}
|
|
|
|
ol.upperalpha {
|
|
list-style: upper-alpha;
|
|
}
|
|
|
|
ol.lowerroman {
|
|
list-style: lower-roman;
|
|
}
|
|
|
|
ol.upperroman {
|
|
list-style: upper-roman;
|
|
}
|
|
|
|
:not(li) > ol > li:first-child > :first-child,
|
|
:not(li) > ul > li:first-child > :first-child {
|
|
margin-top: 0px;
|
|
}
|
|
|
|
:not(li) > ol > li:last-child > :last-child,
|
|
:not(li) > ul > li:last-child > :last-child {
|
|
margin-bottom: 0px;
|
|
}
|
|
|
|
ol.simple ol p,
|
|
ol.simple ul p,
|
|
ul.simple ol p,
|
|
ul.simple ul p {
|
|
margin-top: 0;
|
|
}
|
|
|
|
ol.simple > li:not(:first-child) > p,
|
|
ul.simple > li:not(:first-child) > p {
|
|
margin-top: 0;
|
|
}
|
|
|
|
ol.simple p,
|
|
ul.simple p {
|
|
margin-bottom: 0;
|
|
}
|
|
|
|
dl.footnote > dt,
|
|
dl.citation > dt {
|
|
float: left;
|
|
margin-right: 0.5em;
|
|
}
|
|
|
|
dl.footnote > dd,
|
|
dl.citation > dd {
|
|
margin-bottom: 0em;
|
|
}
|
|
|
|
dl.footnote > dd:after,
|
|
dl.citation > dd:after {
|
|
content: "";
|
|
clear: both;
|
|
}
|
|
|
|
dl.field-list {
|
|
display: grid;
|
|
grid-template-columns: fit-content(30%) auto;
|
|
}
|
|
|
|
dl.field-list > dt {
|
|
font-weight: bold;
|
|
word-break: break-word;
|
|
padding-left: 0.5em;
|
|
padding-right: 5px;
|
|
}
|
|
|
|
dl.field-list > dt:after {
|
|
content: ":";
|
|
}
|
|
|
|
dl.field-list > dd {
|
|
padding-left: 0.5em;
|
|
margin-top: 0em;
|
|
margin-left: 0em;
|
|
margin-bottom: 0em;
|
|
}
|
|
|
|
dl {
|
|
margin-bottom: 15px;
|
|
}
|
|
|
|
dd > :first-child {
|
|
margin-top: 0px;
|
|
}
|
|
|
|
dd ul, dd table {
|
|
margin-bottom: 10px;
|
|
}
|
|
|
|
dd {
|
|
margin-top: 3px;
|
|
margin-bottom: 10px;
|
|
margin-left: 30px;
|
|
}
|
|
|
|
dl > dd:last-child,
|
|
dl > dd:last-child > :last-child {
|
|
margin-bottom: 0;
|
|
}
|
|
|
|
/* dt:target, span.highlighted {
|
|
background-color: #fbe54e;
|
|
} */
|
|
|
|
rect.highlighted {
|
|
fill: #fbe54e;
|
|
}
|
|
|
|
dl.glossary dt {
|
|
font-weight: bold;
|
|
font-size: 1.1em;
|
|
}
|
|
|
|
.optional {
|
|
font-size: 1.3em;
|
|
}
|
|
|
|
.sig-paren {
|
|
font-size: larger;
|
|
}
|
|
|
|
.versionmodified {
|
|
font-style: italic;
|
|
}
|
|
|
|
.system-message {
|
|
background-color: #fda;
|
|
padding: 5px;
|
|
border: 3px solid red;
|
|
}
|
|
|
|
.footnote:target {
|
|
background-color: #ffa;
|
|
}
|
|
|
|
.line-block {
|
|
display: block;
|
|
margin-top: 1em;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
.line-block .line-block {
|
|
margin-top: 0;
|
|
margin-bottom: 0;
|
|
margin-left: 1.5em;
|
|
}
|
|
|
|
/* .guilabel, .menuselection {
|
|
font-family: sans-serif;
|
|
} */
|
|
|
|
.accelerator {
|
|
text-decoration: underline;
|
|
}
|
|
|
|
.classifier {
|
|
font-style: oblique;
|
|
}
|
|
|
|
.classifier:before {
|
|
font-style: normal;
|
|
margin: 0.5em;
|
|
content: ":";
|
|
}
|
|
|
|
/* abbr, acronym {
|
|
border-bottom: dotted 1px;
|
|
cursor: help;
|
|
} */
|
|
|
|
/* -- code displays --------------------------------------------------------- */
|
|
|
|
pre {
|
|
overflow: auto;
|
|
overflow-y: hidden; /* fixes display issues on Chrome browsers */
|
|
}
|
|
|
|
/* pre, div[class*="highlight-"] {
|
|
clear: both;
|
|
} */
|
|
|
|
span.pre {
|
|
-moz-hyphens: none;
|
|
-ms-hyphens: none;
|
|
-webkit-hyphens: none;
|
|
hyphens: none;
|
|
}
|
|
|
|
/* div[class*="highlight-"] {
|
|
margin: 1em 0;
|
|
} */
|
|
|
|
td.linenos pre {
|
|
border: 0;
|
|
background-color: transparent;
|
|
color: #aaa;
|
|
}
|
|
|
|
table.highlighttable {
|
|
display: block;
|
|
}
|
|
|
|
table.highlighttable tbody {
|
|
display: block;
|
|
}
|
|
|
|
table.highlighttable tr {
|
|
display: flex;
|
|
}
|
|
|
|
table.highlighttable td {
|
|
margin: 0;
|
|
padding: 0;
|
|
}
|
|
|
|
table.highlighttable td.linenos {
|
|
padding-right: 0.5em;
|
|
}
|
|
|
|
table.highlighttable td.code {
|
|
flex: 1;
|
|
overflow: hidden;
|
|
}
|
|
|
|
/* .highlight .hll {
|
|
display: block;
|
|
} */
|
|
|
|
div.highlight pre,
|
|
table.highlighttable pre {
|
|
margin: 0;
|
|
}
|
|
|
|
div.code-block-caption + div {
|
|
margin-top: 0;
|
|
}
|
|
|
|
div.code-block-caption {
|
|
margin-top: 1em;
|
|
padding: 2px 5px;
|
|
font-size: small;
|
|
}
|
|
|
|
div.code-block-caption code {
|
|
background-color: transparent;
|
|
}
|
|
|
|
table.highlighttable td.linenos,
|
|
span.linenos,
|
|
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
|
|
user-select: none;
|
|
}
|
|
|
|
div.code-block-caption span.caption-number {
|
|
padding: 0.1em 0.3em;
|
|
font-style: italic;
|
|
}
|
|
|
|
div.code-block-caption span.caption-text {
|
|
}
|
|
|
|
div.literal-block-wrapper {
|
|
margin: 1em 0;
|
|
}
|
|
|
|
code.descname {
|
|
background-color: transparent;
|
|
font-weight: bold;
|
|
/* font-size: 1.2em; */
|
|
}
|
|
|
|
code.descclassname {
|
|
background-color: transparent;
|
|
}
|
|
|
|
/* code.xref, a code {
|
|
background-color: transparent;
|
|
font-weight: bold;
|
|
} */
|
|
|
|
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
|
|
background-color: transparent;
|
|
}
|
|
|
|
.viewcode-link {
|
|
float: right;
|
|
}
|
|
|
|
.viewcode-back {
|
|
float: right;
|
|
font-family: sans-serif;
|
|
}
|
|
|
|
div.viewcode-block:target {
|
|
margin: -1px -10px;
|
|
padding: 0 10px;
|
|
}
|
|
|
|
/* -- math display ---------------------------------------------------------- */
|
|
|
|
img.math {
|
|
vertical-align: middle;
|
|
}
|
|
|
|
div.body div.math p {
|
|
text-align: center;
|
|
}
|
|
|
|
span.eqno {
|
|
float: right;
|
|
}
|
|
|
|
span.eqno a.headerlink {
|
|
position: absolute;
|
|
z-index: 1;
|
|
}
|
|
|
|
div.math:hover a.headerlink {
|
|
visibility: visible;
|
|
}
|
|
|
|
/* -- printout stylesheet --------------------------------------------------- */
|
|
|
|
@media print {
|
|
div.document,
|
|
div.documentwrapper,
|
|
div.bodywrapper {
|
|
margin: 0 !important;
|
|
width: 100%;
|
|
}
|
|
|
|
div.sphinxsidebar,
|
|
div.related,
|
|
div.footer,
|
|
#top-link {
|
|
display: none;
|
|
}
|
|
}
|