In order for javascript translations to become active, the corresponding
addon needs to follow a certain naming scheme or register explicitly.
This commit updates the internationalization guide with a respective
hint.
Fixesodoo/documentation#1676closesodoo/documentation#1727
X-original-commit: 112b6c1267
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
All examples on the page suggest calling the CLI with "odoo-bin" while
it is recommended to call it with "odoo" when Odoo was installed from a
distribution package. It also failed to mention the location of
"odoo-bin" relative to the source files.
The chance is also taken to rename the somewhat unclear page title to
something more clear and generic.
closesodoo/documentation#1699
X-original-commit: c018a53686
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
In d46e358d3e88aea9f9289c4845c6c87ab9491c55 some mail.thread method
names were changed: it should be changed in documentation too.
closesodoo/documentation#1686
X-original-commit: b24560e224
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Introduce changelog of the ORM by version, link to first change documented
closesodoo/documentation#1508
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Recently, the API of useAutofocus has been simplified (see 4308de6aab).
Here we adapt its documentation.
closesodoo/documentation#1572
Signed-off-by: Mathieu Duckerts-Antoine <dam@odoo.com>
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>
Adding basic information about `How to make a test tour`.
task-2742841
closesodoo/documentation#1524
X-original-commit: dbd5a1e1bb
Signed-off-by: Morgane Demesmaeker <edm@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Select links and pieces of information from Odoo Enterprise wiki
were copied over at the end Chap. 2 of the functional training.
These would be useful to have during the tutorial instead of at
the end of it.
closesodoo/documentation#1515
X-original-commit: a9bc16bec8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
This changed for Odoo 15.0 in odoo/odoo#61853 and the docs didn't
reflect that change.
MT-52 @moduon
closesodoo/documentation#1469
X-original-commit: 084fb777f9
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit adds the developer documentation for a
component recently added to the web_enterprise module.
It also includes examples and a screenshot used in the
documentation.
closesodoo/documentation#1432
X-original-commit: 7763c22db4
Signed-off-by: Géry Debongnie <ged@odoo.com>
Signed-off-by: Luca Vitali <luvi@odoo.com>
This commit changes the way that Odoo python dependencies should be
installed.
Before this commit, the described way to install Odoo dependencies was
by using the `pip` utility.
Now, we explicitly recommend to use a Debian based system and install
Odoo dependencies from their packaging tool.
The main reasons are:
* Odoo productions instances are, most of the time, run on Debian based
systems with those package already installed
* That way, a developer cannot mistakenly use a feature from a
dependency that does not exists on those production environments
* Avoid mixes of python packages on the developer/user 's system
closesodoo/documentation#1364
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
The "qweb key of the manifest" file was still mentionned even if it has
been replaced by the assets bundles.
See related task: 2352566
closesodoo/documentation#1434
X-original-commit: dc832e1cc8
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The suggested folder structure does not comply with guidelines:
https://www.odoo.com/documentation/15.0/developer/misc/other/guidelines.html#file-naming
> Concerning printable reports which contain mainly data preparation and Qweb templates naming is
the following :
addons/plant_nursery/
|-- report/
| |-- plant_order_reports.xml (report actions, paperformat, ...)
| |-- plant_order_templates.xml (xml report templates)
closesodoo/documentation#1426
Forward-port-of: odoo/documentation#1350
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Both the functional and technical name of the `ir.rule` model is "Record
Rule". This commit makes sure that all occurrences of "Access Rule" are
replaced by the correct name "Record Rule" as it was easily confused
with "Access Rights".
Original PR: https://github.com/odoo/documentation/pull/1118closesodoo/documentation#1424
X-original-commit: a692dbdc9c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
The training suggests to put the views in the data/ folder instead of the views/ folder
closesodoo/documentation#1418
X-original-commit: 9d45b861c0
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
- reset the `currentmodule` so the fields are not attributed to
`odoo.fields`, also prefix the field names (for a similar reason)
- expand `active` with the documentation of the related methods
closesodoo/documentation#1352
Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com>
* remove the documentation for `_auto`, `abstract`, and `_transient`
as that's redundant with `Model`
* add documentation for transients' dedicated attributes (and main
method whose docstring explains what actually occurs)
Part-of: odoo/documentation#1352
This commit applies some remarks by Antoine.
closesodoo/documentation#1328
X-original-commit: 8c1003e363
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit adds the documentation related to
the scroller service. This service is used for
the webclient to handle clicks on links and there
were no documentation related until now.
closesodoo/documentation#1326
X-original-commit: 1f84bab97d
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
and add entry for effects registry as well
closesodoo/documentation#1303
X-original-commit: 624131f712
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
Syntax was added to explicitly specify a module, class or function with
`--test-tags`: b729a11a12
The documentation was not updated to reflect this, leading to confusion
as people tried to reconcile the documentation with the actual behavior,
without necessarily having seen `odoo-bin --help` which is explicit
about it.
closesodoo/documentation#1282
X-original-commit: 77dd769b08
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Raf Geens <raf@odoo.com>
The preferred format for (frontend) references is now:
"frontend/filename/section", or something close to that.
closesodoo/documentation#1294
X-original-commit: 894165a949
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
This commit is a move, but the content was also slightly
updated/reformatted.
closesodoo/documentation#1288
X-original-commit: f206233ebc
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
- add a link to services
- add a note that the env is quite powerful
- reformat the table with the list-table role, to make it easier to edit
closesodoo/documentation#1268
X-original-commit: 1e6c12be30
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
This commit update the registry documentation to use the js domain
directives instead of trying to format functions with code blocks.
I am not impressed with the way it looks, but in any cases, it is
certainly better to properly structure the documentation.
closesodoo/documentation#1262
X-original-commit: ce96d6c584
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
This commit adds a pretty important missing piece of information: the
assets key in the manifest. At the same time, we remove two keys that
are no longer in use.
closesodoo/documentation#1261
X-original-commit: a2a389688c
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Now that the reference is split into backend/frontend, it makes more
sense to have the assets page into the frontend section.
closesodoo/documentation#1260
Signed-off-by: Géry Debongnie (ged) <ged@openerp.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
As of commit https://github.com/odoo/odoo/commit/794677fb Python 3.7 is
the minimum required version for Python when running Odoo 15.0.
This also applies to building the version 15.0 of the documentation.
closesodoo/documentation#1255
X-original-commit: 26042f541a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit updates the documentation of the map view.
There were missing map attributes, typos and wrong descriptions.
closesodoo/documentation#1232
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
and move the section on environment to the framework main documentation
page.
closesodoo/documentation#1237
X-original-commit: 05ab4a7b0a
Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
This commit moves most of the content out of the javascript reference
and into a more visible page.
closesodoo/documentation#1211
X-original-commit: c6f813f4cb
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
- Reference v15 training solutions
- Refer to Command namespace instead of triplets (e.g.
Command.create(values) instead of (0, 0, values)
- Add notice about OWL transition
- Add reference to @api.ondelete (instead of override unlink())
- Remove references to SavepointCase (now only TransactionCase) from
unit test topic
- Also add missing reference documentation for ondelete
closesodoo/documentation#1146
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
- Cleaned up the language a tiny bit
- Fixed small errors/typos
- Add some missing info for dashboard topic
- Updated unit test exercise to match what's in the solutions repo
Part-of: odoo/documentation#1146
There have been complaints of newbies not setting up their linters
therefore let's emphasize their use/setup more in the tutorial and hope
for the best.
Part-of: odoo/documentation#1146
Brings some modification to the documentation on cohort, graph, and
pivot views according to the recent refactoring of the reporting views
in owl.
Related commits:
closesodoo/documentation#1123
Community: odoo/odoo#73311
Enterprise: odoo/enterprise#19469
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Since the update of the themes tutorial, the id of the snippet template was modified
but this part of the tutorial wasn't updated accordingly.
This commit updates the referenced template id to make sure the tutorial works
as expected.
Finetuning of 08d44d4444
This commit relates to a new community feature:
A read_group on a date(time) field will also return a __range property with
the date bounds of the group [from, to[
The community commit also introduces a new xml attribute
`allow_group_range_value` for `<kanban>` `<field>`, and this commit is the
documentation for that attribute.
allow_group_range_value (boolean):
- to perform a drag&drop or a quickCreate, we must be able to get and use the
value from the group containing the record. The last date of the group will
be taken as the record's field value.
- allows (or disallows) date(time) non-readonly fields to be:
- draggable
- quick created
- defaults to false.
Task-ID: 2243913
Community PR odoo/odoo#69380
Commit: [IMP] core, web: add a range for date(time) read_group
`web` is not used directly and is installed automatically anyway.
Having both `web` and `base` looks excessively, so coaches usually ask to delete
`base`. But more correct solution is adding `base` only. Completly skipping
dependencies is not good either -- see 76e05ccfb8
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
* readonly is True for related fields.
Since Odoo 12: 52a8ed3c0c
This commit also highlights all the default values of related fields, fixing
the misleading message about related computed in sudo mode (since it can
be disabled with compute_sudo or related_sudo = False)
---
task-2451749
no need to fetch all branches from odoo/technical-training-sandbox
Also, ``git push`` without upstream may not work depending on git
version/configuration:
```
$ git push -u master-my_first_branch-IEL
fatal: The current branch master-my_first_branch-IEL has no upstream branch.
To push the current branch and set the remote as upstream, use
git push --set-upstream master-my_first_branch-IEL master-my_first_branch-IEL
```
The new R&D training is intended to replace the existing technical
training(s). It is organized as follow:
- A core training, with chapters to follow in order (1 - 16)
- Advanced topics, with independent chapters (A - O)
The advanced topics should be done after the core training.
Co-authored-by: Nicolas Martinelli <nim@odoo.com>
Co-authored-by: Jorge Pinna Puissant <jpp@odoo.com>
Co-authored-by: wan <wan@odoo.com>
Co-authored-by: Xavier Morel <xmo@odoo.com>
Co-authored-by: Tiffany Chang (tic) <tic@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
