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
61 lines
2.5 KiB
JavaScript
61 lines
2.5 KiB
JavaScript
/* global _prepareAccordion */ //see utils.js
|
|
(function ($) {
|
|
|
|
document.addEventListener('DOMContentLoaded', () => {
|
|
this.navigationMenu = document.getElementById('o_main_toctree');
|
|
|
|
// Allow to automatically collapse and expand TOC entries
|
|
_prepareAccordion(this.navigationMenu);
|
|
|
|
// Allow to respectively highlight and expand the TOC entries and their related TOC
|
|
// entry list whose page is displayed.
|
|
_flagActiveTocEntriesAndLists();
|
|
|
|
// Show hidden menu when the css classes have been properly specified
|
|
this.navigationMenu.removeAttribute('hidden');
|
|
});
|
|
|
|
/**
|
|
* Add the relevant classes on the TOC entries (and lists) whose page is displayed.
|
|
*
|
|
* TOC entries (<li> elements) that are on the path of the displayed page receive the
|
|
* `o_active_toc_entry` class, and their related (parent) TOC entry list (<ul> elements) receive
|
|
* the `show` (Bootstrap) class.
|
|
* Also, the deepest TOC entry receives the `o_deepest_active_toc_entry` class, and its child
|
|
* TOC entry list receives the `show` class.
|
|
*/
|
|
const _flagActiveTocEntriesAndLists = () => {
|
|
let deepestTocEntry = undefined;
|
|
this.navigationMenu.querySelectorAll('.current').forEach(element => {
|
|
if (element.tagName === 'UL') {
|
|
// Expand all related <ul>
|
|
element.classList.add('show');
|
|
} else if (element.tagName === 'LI') {
|
|
// Highlight all <li> in the active hierarchy
|
|
element.classList.add('o_active_toc_entry');
|
|
deepestTocEntry = element;
|
|
}
|
|
})
|
|
if (deepestTocEntry) {
|
|
const childTocEntryList = deepestTocEntry.querySelector('ul');
|
|
if (childTocEntryList) {
|
|
childTocEntryList.classList.add('show');
|
|
} else { // If the toc entry is not a TOC, add the class to its closest ancestor entry
|
|
deepestTocEntry = deepestTocEntry.parentElement.parentElement;
|
|
}
|
|
deepestTocEntry.classList.add('o_deepest_active_toc_entry');
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Mobile: Toggle open/close sidebar on click of nav button (&& on swipe left to right?).
|
|
*
|
|
*
|
|
* `o_active_toc_entry` class, and their related (parent) TOC entry list (<ul> elements) receive
|
|
* the `show` (Bootstrap) class.
|
|
* Also, the deepest TOC entry receives the `o_deepest_active_toc_entry` class, and its child
|
|
* Sidebar receives the `o-mobile-show` class.
|
|
*/
|
|
|
|
})();
|