This should help reading the traceback on Runbot, where the log files
are not always kept.
closesodoo/documentation#9072
X-original-commit: 73ee687aca
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
* latest droid package does not allow \usepackage{droid} anymore,
replace it with the right package
See https://github.com/MiKTeX/miktex-packaging/issues/136
* remove reference to package texlive-generic-recommended since
it's not available nor necessary since ubuntu 20.04.
closesodoo/documentation#3204
X-original-commit: 816f437064
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
pysassc utility is called in the Makefile. On some system (e.g.: the latest
Dockerfile of the runbot) this utility cannot be found in the system's
paths.
As the pysassc utility is a wrapper for the python module, we can simply
call the python module by it's entrypoint.
Also, this commit fixes the requirements as the pysass package was
installed to incidentally install libsass.
closesodoo/documentation#1277
X-original-commit: cbd85f1f47
Signed-off-by: Christophe Monniez (moc) <moc@odoo.com>
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#1096
X-original-commit: d8684e8963
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.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#1089
X-original-commit: fd56d8c170
Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com>
Signed-off-by: Xavier Dollé (xdo) <xdo@odoo.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#1078
X-original-commit: 9bad0540b0
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.
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
* should not be invoked when just editing documentation (and not
touching less files) due to make dependency checking
* requires lessc on the path
* not sure it works for subfiles of main less file? May need
improvements there
