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>
In `conf.py`, we try to find a Odoo sources folder among `odoo` and
`../odoo` directories without really checking that they really are
Odoo sources folders, leading to doc generation error if it's not the case.
So, to improve that, this commit checks that the selected Odoo sources folder
contains `odoo-bin`.
While we're at it, the logging is also improved to always display the
matching odoo sources' folder and version.
closesodoo/documentation#1341
X-original-commit: 57e1e31433
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne <anv@odoo.com>
Since odoo/odoo@794677fb6a Odoo requires python 3.7 min.
However, it still runs fine in 3.6 and this is the python version of
the build server.
Fake the version to be able to build the doc on the nightly server.
To be removed once the nightly server is migrated.
closesodoo/documentation#1259
X-original-commit: 4fb6c72d75
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.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.
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
- Update Enterprise & Partnership agreement (EN, FR)
- Update legal page index: hide outdated agreements, replace
with a link to an archive of the old PDFs.
- Add icons for missing files, to make index table layout more consistent
- Add `text-justify` on HTML versions of contracts, for consistency with
the PDF versions.
- Fix compatibility of PDF generation with recent sphinx versions
(\sphinxmaketitle instead of \maketitle)
- Re-add NL PDF building, still needs to be updated like all others
Backport of 5b80ed551c from 13.0
- Update Enterprise & Partnership agreement (EN, FR)
- Update legal page index: hide outdated agreements, replace
with a link to an archive of the old PDFs.
- Add icons for missing files, to make index table layout more consistent
- Add `text-justify` on HTML versions of contracts, for consistency with
the PDF versions.
- Fix compatibility of PDF generation with recent sphinx versions
(\sphinxmaketitle instead of \maketitle)
- Re-add NL PDF building, still needs to be updated like all others
Because:
- Mementos are already referenced multiple times in related toctrees.
- Only two mementos are remaining, which is not enough to justify a whole doc category.
- References to mementos are easily broken without being detected at compilation time.
Keep the language in multilang versions of pages. The canonical should look like:
/documentation/user/12.0/sale.html -> /documentation/user/13.0/sale.html
/documentation/user/11.0/fr/website.html -> /documentation/user/13.0/fr/website.html
Needs the changes at odoo/saas-automation#40 that will change the
canonical_root
- from https://www.odoo.com/documentation/user/
- to https://www.odoo.com/documentation/user/12.0/
This way, the language switcher will keep the current version,
changing from English to French will make
/documentation/user/12.0/website.html -> /documentation/user/12.0/fr/website.html
(and not -> /documentation/user/13.0/website.html as before)
Keep the language in multilang versions of pages. The canonical should look like:
/documentation/user/12.0/sale.html -> /documentation/user/13.0/sale.html
/documentation/user/11.0/fr/website.html -> /documentation/user/13.0/fr/website.html
Needs the changes at odoo/saas-automation#40 that will change the
canonical_root
- from https://www.odoo.com/documentation/user/
- to https://www.odoo.com/documentation/user/12.0/
This way, the language switcher will keep the current version,
changing from English to French will make
/documentation/user/12.0/website.html -> /documentation/user/12.0/fr/website.html
(and not -> /documentation/user/13.0/website.html as before)
Keep the language in multilang versions of pages. The canonical should look like:
/documentation/user/12.0/sale.html -> /documentation/user/13.0/sale.html
/documentation/user/11.0/fr/website.html -> /documentation/user/13.0/fr/website.html
Needs the changes at odoo/saas-automation#40 that will change the
canonical_root
- from https://www.odoo.com/documentation/user/
- to https://www.odoo.com/documentation/user/12.0/
This way, the language switcher will keep the current version,
changing from English to French will make
/documentation/user/12.0/website.html -> /documentation/user/12.0/fr/website.html
(and not -> /documentation/user/13.0/website.html as before)
Sections get an id automatically generated from the title, "journal
entries" and "chart of accounts" are pretty generic concepts, so the
widgets looking for these ids can get enabled on sections they're not
intended to live in.
On the other hand, Sphinx is not likely to generically create classes
for these concepts without being explicitly prompted (via
e.g. rst-class).
Turns out exclude_patterns is used when looking for markup source
files but also when looking for HTML static files, which is noted in
the documentation but apparently not in the sample conf.py
Don't exclude_patterns _-prefixed directories, or _static isn't copied
and a bunch of images and JS files break.
* by-application (odoo-wise) grouping
* use part of the accounting TOC defined on pad
* support for "internal" tocs & fixup front toc
* various changes and improvements to extensions
May be missing: inherited document banners?
