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
closesodoo/documentation#2201
X-original-commit: c0040fa532
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
The page was moved from odoo.rst to external_api.rst with commit
0fc52188.
task-2870501
closesodoo/documentation#2143
X-original-commit: f6cd947d6b
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
urlBase was only containing the domain name, not the /documentation/
closesodoo/documentation#2062
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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
closesodoo/documentation#2052
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>
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#1692
This commit removes unnecessary negative margins and makes code-blocks
inside content tabs lose their bottom margin and border.
closesodoo/documentation#1673
X-original-commit: ac28acee4a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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#1673
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
closesodoo/documentation#1666
X-original-commit: 7250f88b8d
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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
closesodoo/documentation#1595
X-original-commit: c30f2735b8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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.
closesodoo/documentation#1583
X-original-commit: 3febaffd75
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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#1260
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.
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.
According to the app-store guidelines we are not allowed to sell from
the iOS app.
Our updates are currently blocked because of this.
In the rush, we have no choice but to hide "Try Odoo for FREE" buttons
that redirects the customer to the subscription page.
This is unfortunately not allowed by Apple who consider this
as "In-App Purchase".
Note that in the old documentation (https://www.odoo.com/documentation/user),
this button was located in the header which was hidden in the app
(see related PR).
Source: https://developer.apple.com/app-store/review/guidelines/#business
Related PR:
odoo/mobile-ios#102odoo/mobile-ios#103
Task-id: 2483253
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.
# If you feel that it might help a future reader to understand your commit
# motivations, take some time to explain WHY you made these changes in a few
# sentences. The WHAT is usually easily understood by reading the diff.
#
# Short description tip: structure your commit message as if it was completing
# this sentence: "If merged, this commit will ...". For instance, the following
# commit message is correct: "[IMP] sales: compress images to save space".
#
# Tag meanings:
#
# [ADD] = New content
# [IMP] = Improvement
# [FIX] = Content or RST fix
# [REM] = Removal
# [REF] = Refactoring (restructuring)
# [MOV] = Move/rename
#
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
