The padding was not correctly set because the admonition was included
in an <ul> element which was itself inside another <ul> element.
The table below the admonition is also moved outside of the <ul>
because it is semantically incorrect.
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
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
- 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
When navigating the themes tutorial (developer/howto/themes), the
rdtraining page wasn't clickable in the global toc, even though it was
specified as :show-content: (note that the rdtraining is only in 14.0+).
The heuristic extracting the pagename from a toctree node wasn't
considering the current depth if the page referenced by the toctree
node was in the same folder than the current page.
Explanation:
We are computing the toctree for the page developer/howtos/themes. One
of the toctree nodes references the rdtraining page, with a relative
link, i.e. `rdtraining.html`.
We were wrongfully looking for `show_content` in the metadata of the
`rdtraining` page, instead of `developer/howtos/rdtraining`, since we
didn't consider the current document depth when the reference didn't
contain any `/`.
This commit ensures that if the current document has a depth > 1, this
depth is currently considered, even for links referencing documents in
the same folder.
task-2538297
Now that patchqueue was removed, we can consider supporting the parallel
read with our local extensions.
Since we only have basic extensions, not storing any data on the build
environment, the change mainly consists of specifying the extensions as
parallelizable.
The only specific case is the html domain, since the base html domain
requires the support of the method merge_domaindata in parallel read
mode. Since we do not need to share anything between the envs for this
extension, we can simply ignore the method.
This commit removes the extra search bar that was dedicated to the
mobile layout and adapts the desktop's one to be compatible with mobile.
It also brings back the "Hide Search Matches" button.
This avoids to have URL pointing to
https://www.odoo.com/documentation/user/<VERSION>/<LANG>/odoo_enterprise_agreement.pdf
when switching a language
The pdf are built only once and are global per version
Remove the patchqueue extension from the doc requirements since it isn't
maintained anymore (raising warnings for recent sphinx versions) and the
patches to specify code blocks aren't easy to maintain.
Remove hidden code patches, and replaces shown patches by code block /
literalincludes to keep the useful content.
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
Prepare the incoming documentation refactoring, ensuring the files used by a doc page
are correcly moved together with the page, avoiding broken links during the reorganisation.
Partial backport of f7bedfce2e
to ease forward-ports
