The docutils is pinned to 0.16.0 while the Jammy version should be 0.17
This is the case for a compatibility issue with sphinx-tabs==3.2.0
also official versions in ubuntu Jammy.
The odoo.requirements package contains already a docutils 0.17.0
creating some downgrade when installing requirements, this commit
upgrade both dependency to a compatible version.
This should avoid installing requirements in all documentation build
and hopefully avoid some random errors.
closesodoo/documentation#9115
Signed-off-by: Christophe Monniez (moc) <moc@odoo.com>
It seems that the latest version if sphinx contrib libs needs sphinx 5.0.
closesodoo/documentation#7411
X-original-commit: 38bd71fa13
Signed-off-by: Christophe Monniez (moc) <moc@odoo.com>
In Odoo, the libsass version was bumped to 0.20.1 in order to match the
Jammy version. As a consequence, in the Docker images on the runbot this
strange behavior was observed during the image build:
* the debian package is installed -> 0.20.1
* the documentation requirements are installed -> 0.18.0
* the odoo requirements are installed -> 0.20.1
This is useless and moreover, the final version used is the one from pip
instead of the Debian package.
closesodoo/documentation#4397
X-original-commit: dcc819469a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Christophe Monniez (moc) <moc@odoo.com>
- Bump Sphinx version to 4.3.2 (default for Debian Jammy).
- Remove the retrocompatibility for Sphinx < 3.5 (warnings are raised in
4.5).
- Fix translator issue crashing builds.
- Unpin jinja2 from the requirements as the base issue is solved in sphinx 4
Task - 2898477
Part-of: odoo/documentation#2455
Since sphinx-tabs 3.2.0 has the requirement docutils==0.16.0 and sphinx
3.5.4 has the requirement docutils>=0.12,<0.17, this commit pins
docutils to version 0.16.0.
While we're at it, the dependency to sphinx-tabs is also explicitly
listed, although it was already imported in the extensions. It causes
no trouble to install it from pip alongside the imported extension.
closesodoo/documentation#2178
X-original-commit: 9d36e4e2a4
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The latest versions of Jinja2 are no longer compatible with the latest
version of Sphinx 3 (3.5.4).
task-2828982
closesodoo/documentation#2001
X-original-commit: 4c7e89d872
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Also add a condition on some directives to ignore them when we have no
relative/absolute path.
X-original-commit: a514c905c0
Part-of: odoo/documentation#1969
In many places in the docs, we need to document several flows that
differ only by a few details. For example, the steps to install Odoo
from the sources are almost identical for Windows, Linux, and Mac OS.
In other places, we'd want to suggest a command in different
environments or programming languages, etc.
This commit thus adds an extension for content tabs (tabs within the
content) to help reduce content repetition in the documentation. As a
proof of concept, the "Packaged installers" and "Source install"
sections of the "Installing Odoo" page are reworked to present their
content within tabs whenever it helps clarify the instructions.
A new python dependency is added as of this commit: `sphinx-tabs`
task-2713983
closesodoo/documentation#1528
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Lucie Van Nieuwenhuyse (luvn) <luvn@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>
As of sphinx 3.5.4, docutils >0.17 is no longer supported. To avoid
forcing the install of an unsupported version of docutils, we let
sphinx install the appropriate version through its dependencies.
closesodoo/documentation#1276
X-original-commit: 116d9b5181
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
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
