Backport of https://github.com/odoo/documentation/pull/1002 .
In V12 and V13, Gengo can't be used on SaaS and Odoo.sh by default
because they don't install the gengo Python library. If the library
is installed on Odoo.sh by the user, it still won't work, because there's
a typo in `base.gengo.translations` here (the -s is missing):
651caf0f59/addons/base_gengo/controller/main.py (L15)
This code is responsible for handling the results returned by Gengo when
the translation is ready. The typo has been present since at least 2016.
Meaning this can't have worked during that period. Fixing that typo
results in the json.loads following it failing due to an unexpected
number of arguments. That code looks it hasn't ran in a long while.
So I propose to remove mention of Gengo from the documentation in V12
and V13 to avoid any future confusion about it possibly working. Since
the feature can't have worked and support for it in V14 has already been
dropped, it doesn't seem worthwhile to attempt to bugfix it at this stage.
When locally building the doc (aka make), CURRENT_LANG is not defined,
which results in HTML_BUILD_DIR = _build/html//, resulting in commands
& logs like the following
mkdir -p _build/html//_static
pysassc extensions/odoo_theme/static/style.scss _build/html//_static/style.css
This has no impact on linux builds, but could be unclear/confusing for some non tech
users (can it have any impact on other OS's/distros ?)
closesodoo/documentation#1093
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
The previous makefile was compiling css beside the style.scss and
the style.css was copied at the end.
The new makefile compile css directly in the build dir.
Since this file was still present in the source because of the .gitignore,
sphinx was using this old version of style.css, overriding the new compiled
css file at the end.
Removing it from gitignore should helpFix this problem.
This commit also fix some path in makefile.
(not critical but this should fix a potential error in static command)
closesodoo/documentation#1084
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
Commit 547d90a allowed `BUILD_DIR` to be defined from the CLI but didn't
update usages of `HTML_BUILD_DIR`. When building the documentation for
multiple versions and/or languages, we should rely on `HTML_BUILD_DIR`
to point to the appropriate directory.
closesodoo/documentation#1075
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
Building documentation implies some constraints: the source folder is
readonly, mainly because the sources are shared accros builds.
This implies that nor a symlink and a _build dir cannot be added in the
source directory.
The symlink will work in most cases localy for user with strange
multiverse structure, but if not found, the fallback will check in
parent directory. Most users and runbot will have all sources in the
same directory (both in universe and basic multiverse cases)
-(version?)
-odoo
-enterprise
-upgrade
-documentation
The second change will check if BUILD_DIR is defined before setting it,
allowing to use 'make BUILD_DIR=../build' to output the documentation
somewhere else.
When searching for a string that can be found in a TOC page's content,
that page is listed in the search results. This is not a wanted behavior
because TOC pages without the 'show-content' metadata directive are not
supposed to be accessible.
This commit adds a 'nosearch' metadata directive to all TOC pages
without a 'show-content' metadata directive, hence removing them from
search results.
task-2527419
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 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.
