Compare commits

...

47 Commits

Author SHA1 Message Date
Jonathan Castillo (jcs)
fe79dfdc9e [ADD] accounting/l10n: new egyptian localization and einvoicing section
task-id 2858349
2022-06-02 13:37:18 +02:00
william
8acca3e1ac [FIX] conf: dynamic LaTeX releasename
closes odoo/documentation#2112

X-original-commit: 6d4f4f7d9b
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-05-30 17:45:49 +02:00
Demesmaeker
e92edc5a06 [IMP] amazon: migrate to SPAPI
Starting July 2022, Amazon WMS API is deprecated and we need to use the Selling Partners API.

This brings changes in the authentication flow that are explained.

task-2466636

closes odoo/documentation#2103

X-original-commit: 2dd3a4ae74
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-30 16:43:59 +02:00
Odoo Translation Bot
00bc48ebaf [I18N] Update translation terms from Transifex 2022-05-29 01:40:20 +02:00
Michelle Vu (mivu)
2dbe17bb4e [IMP] helpdesk: update flow and images for reinvoicing time
closes odoo/documentation#2093

X-original-commit: 00ec789d96
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-27 12:01:47 +02:00
Michelle Vu (mivu)
6dc30adf15 [IMP] payment: update SIX screenshots
closes odoo/documentation#2085

X-original-commit: f6b22996b7
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-27 10:59:42 +02:00
Michelle Vu (mivu)
42d1f1736f [FW][IMP] calendar: update Google Calendar sync screenshots
Task ID: 2685658

closes odoo/documentation#2084

Forward-port-of: odoo/documentation#1982
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-25 14:58:08 +02:00
Donatienne Pirlot
02a2d471ba [IMP] accounting: update the follow-up information
Task ID: 2735445

closes odoo/documentation#2077

X-original-commit: ffc23483ca
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Pirlot Donatienne (dopi) <dopi@odoo.com>
2022-05-24 16:29:39 +02:00
Michelle Vu (mivu)
47d1146c10 [ADD] discuss: configure Twilio ICE servers
closes odoo/documentation#1994

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-23 09:29:54 +02:00
Odoo Translation Bot
c924b21b81 [I18N] Update translation terms from Transifex 2022-05-22 01:40:23 +02:00
Donatienne Pirlot
cabfbb5fc2 [IMP] accounting : update the list of fiscal localization packages
task id: 2858536

closes odoo/documentation#2045

X-original-commit: 18f8b286d5
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-05-20 15:20:13 +02:00
Antoine Vandevenne (anv)
5a7048eb0a [MOV] developer/api/odoo: rename odoo.rst into external_api.rst
The previous file name was not very relevant in regard to the content of
the page, and it conflicted with the `sys.path`.

closes odoo/documentation#2064

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-20 14:10:01 +02:00
Antoine Vandevenne (anv)
17df8c547a [MOV] content/*: move resource files into their related page's directory
Since odoo/documentation#903, the guideline for the location of new
resource (images, downloadable files, RST includes...) files is to place
those inside the directory of the RST page that references them.

For example, if `doc1.rst` has a reference to `image.png` and to
`download.zip`, the file structure should look like this:

├── parent_doc/
│     └── doc1/
│     │     └── image.png
│     │     └── download.zip
│     └── doc1.rst
│     └── doc2.rst
├── parent_doc.rst

Before this commit, most of the resource files were still located inside
'media' directories holding all the resource files referenced by RST
pages located at the same level as these directories. In the example
above, a single 'media' directory would hold all the resource files
referenced by both `doc1.rst` and `doc2.rst`. Doing so prevented us from
figuring out easily which resource file was referenced by which RST page
and, thus, lead to unused resource files piling up in the repository. It
also made it more complicated to define codeowners regex rules because a
team could not simply be assigned to `/some_page.*` but needed to be
assigned to both `/some_page\.rst` and to the location of 'media'.

In order to help new content writers figure out the guideline when
taking examples from other RST pages, this commit retroactively applies
the guideline to existing resource files and 'media' directories. The
left-over resource files that are not referenced by any RST page are
removed.

task-2497965

Part-of: odoo/documentation#2064
2022-05-20 14:10:01 +02:00
Martin Trigaux
fbb1cfc90f [FIX] odoo_theme: correctly consider baseurl
urlBase was only containing the domain name, not the /documentation/

closes odoo/documentation#2058

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-20 11:56:45 +02:00
Martin Trigaux
7c2f300c95 [IMP] odoo_theme: introduce fallback URLs for the page switchers
When a user clicks on the link of an alternate page in the version or
language switcher, we now check if the page referenced by the target URL
exists or not. If not, we generate a series of fallback URLs from the
target URL and check whether the targeted resource exists or not, until
we read the root of the documentation. As soon as we find a valid URL,
we redirect the user to it.

This is inspired by the behaviour of docs.python.org's version and
language switchers.

task-2534669

closes odoo/documentation#2044

X-original-commit: 25e863a64c
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 22:32:45 +02:00
Altela Eleviansyah Pramardhika
c583067332 [FW][FIX] developer/howtos: Fixed typo from field to fields
closes odoo/documentation#2030

Forward-port-of: odoo/documentation#2023
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 15:39:42 +02:00
Tori (vpk)
d2a9285bb4 [IMP] CRM: updated lead scoring with note about deprecation
Task ID: 2496900

closes odoo/documentation#2024

X-original-commit: fca684e802
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 15:39:39 +02:00
Tori (vpk)
1b89d20aeb [IMP] CRM: updating flow and screenshots of generating leads
closes odoo/documentation#2018

Task: 2540813
X-original-commit: 44129be225
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 13:06:05 +02:00
Beshoy Nabeih
6d30d81a76 [FIX] developer/frontend: typo in the user menu registry example
closes odoo/documentation#1975

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-19 13:05:59 +02:00
John Kirkwood (kij)
599a137ffc [IMP] developer: clarify options for many2one widget
Only `no_create` is required to hide both the 'Create "xxx"' and the
'Create and Edit...' dropdown menu options.

closes odoo/documentation#1545

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-18 12:36:48 +02:00
Donatienne Pirlot
5de81c9e2d [ADD] accounting: new doc about outstanding account
Task-id 2744131

closes odoo/documentation#1887

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-18 11:10:56 +02:00
Odoo Translation Bot
bac53c282c [I18N] Update translation terms from Transifex 2022-05-15 01:40:22 +02:00
Antoine Vandevenne (anv)
4c7e89d872 [FIX] requirements.txt: pin Jinja2 < 3.1
The latest versions of Jinja2 are no longer compatible with the latest
version of Sphinx 3 (3.5.4).

task-2828982

closes odoo/documentation#1993

X-original-commit: 8f4be8e3ea
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-13 13:17:04 +02:00
Fabrice Henrion
85819de4c4 [IMP] payment acquirers: a note in Authorize.net
closes odoo/documentation#1986

X-original-commit: df10f17c3e
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-05-12 17:31:07 +02:00
Laurent Desausoi (lade)
c788e5f246 [IMP] sale_management: remove price_unit from quotation template
Companion of [1].

[1]: https://github.com/odoo/odoo/pull/47186

opw-2824263

closes odoo/documentation#1976

X-original-commit: f6bf1183db
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Desausoi Laurent (lade) <lade@odoo.com>
2022-05-11 09:24:13 +02:00
Demesmaeker
545bcd7a6d [IMP] amazon: explain how to use a carrier
In case of an unsupported carrier or a self Delivery, Odoo won't block
the user to use the Amazon connector, but explanation were needed for
these cases.

task-2804907

closes odoo/documentation#1960

X-original-commit: 3231d20d92
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-09 14:06:29 +02:00
Antoine Vandevenne (anv)
557b261e01 [FIX] conf: allow building the documentation with Python 3.6.
Commit 3d358fdb introduced a new import of Odoo source files which
complain about the minimal Python version if the hack added by 57e1e314
is not executed early enough.

closes odoo/documentation#1949

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-09 14:06:23 +02:00
Tori (vpk)
a86dd00b41 [IMP] CRM: update multiple sales teams doc
closes odoo/documentation#1957

Task: 2588786
X-original-commit: 98f306eca5
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-09 13:00:04 +02:00
Jeremy Kersten
8df7aa1d3e [IMP] odoo_theme: allow to add plausible script
export PLAUSIBLE_SCRIPT=https://plausible.io/js/script.js
export PLAUSIBLE_DOMAIN=yourdomain.com

closes odoo/documentation#1951

X-original-commit: 4c526eb02f
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Jérémy Kersten <jke@odoo.com>
2022-05-09 11:44:17 +02:00
Zachary Straub (ZST)
72fe4cddd9 [ADD] accounting: avatax integration
closes odoo/documentation#1941

X-original-commit: 093aea15ec
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-09 08:25:44 +02:00
Odoo Translation Bot
d8b5f89b75 [I18N] Update translation terms from Transifex 2022-05-08 01:40:22 +02:00
wan
2da1f72389 [REF] i18n/localization.rst: rework the entire localization tutorial
closes odoo/documentation#1334

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Co-authored-by: William Andre <wan@odoo.com>
Co-authored-by: Ivan Yelizariev <iel@odoo.com>
2022-05-06 17:47:12 +02:00
wan
c4b09dfbd9 [ADD] extension: allow to build graphs using graphviz
Part-of: odoo/documentation#1334
2022-05-06 17:47:11 +02:00
wan
3d358fdbcd [ADD] extensions: new autofield directive
This new directive is generating documentation from Odoo fields. This
can be used to build documentation about business classes.
This will help developpers import/export data and build localization
modules for instance.

Part-of: odoo/documentation#1334
2022-05-06 17:47:11 +02:00
wan
c37f2030dc [ADD] conf: give relative and absolute path to odoo repo
Also add a condition on some directives to ignore them when we have no
relative/absolute path.

Part-of: odoo/documentation#1334
2022-05-06 17:47:11 +02:00
Jonathan Castillo (jcs)
c7de4a7b3f [IMP] install/maintain: add seealso links in domain names doc
closes odoo/documentation#1934

X-original-commit: d7da800674
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-05-06 16:27:28 +02:00
Altela Eleviansyah Pramardhika
fdab26d5c7 [FW][FIX] developer/howtos: missing parentheses in print statement
Added parentheses in a print function

closes odoo/documentation#1927

Forward-port-of: odoo/documentation#1923
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
2022-05-06 11:39:58 +02:00
Jonathan Castillo (jcs)
1997788e81 [IMP] contributing: modify titles and headings guidelines
The previous guidelines for titles and headings included an exception to
capitalize feature names as they are written in the apps. However, this
exception seems to have confused most writers as it isn't always clear
what should be considered as a feature name or what should be considered
as a noun or noun group. This commit removes this exception to make the
writing and reviewing processes easier while retaining good titles and
improving consistency across the documentation. It also changes the
titles of the Accounting section to provide a better example to other
writers.

task-id 2843109

closes odoo/documentation#1912

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
2022-05-05 12:54:55 +02:00
Antoine Dupuis (andu)
555ebf48d7 [FW][IMP] accounting: add a warning about invoices in USD in Mexico
Mexican companies very commonly issue invoices in USD, to be fulfiled
in MXN, at the official exchange rate defined by the Banco de Mexico
on the day of payment.

(Presumably, this is to insure against the volatility of the Mexican
peso.)

Odoo supports this workflow, but only if the payment is registered
directly on the invoice using the 'Register Payment' button.

If the payment is created separately, and then reconciled manually
with the invoice, a whole host of problems occur:
- the payment typically can't be reconciled fully with the invoice,
  (even though that can usually be solved by manually creating
  an exchange move)
- but more problematically, the amounts on the payment CFDI will
  be wrong, and even manually creating an exchange move won't solve
  that.

So, we absolutely need to warn users not to try to do that.

(We've been encountering lots of tickets lately in the tech-support
pipe because of users who tried this and then wonder why it doesn't
work.)

This is currently an issue in 14.0, 15.0 and master.

closes odoo/documentation#1913

Forward-port-of: odoo/documentation#1728
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-05 09:42:05 +02:00
Alexandre de Pape
b2f4a9e818 [FIX] sales: fix typo
critarias -> criteria

closes odoo/documentation#1886

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-05-02 16:22:49 +02:00
Odoo Translation Bot
fa0cffd672 [I18N] Update translation terms from Transifex 2022-05-01 01:40:34 +02:00
root
8d63b494c3 [ADD] multi_website: add info to configure multiple domains
closes odoo/documentation#1891

X-original-commit: 324936c43e
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-28 18:02:09 +02:00
Antoine Vandevenne (anv)
71d7500ffa [ADD] .gitattributes: include RST files in language statistic on GitHub
closes odoo/documentation#1890

X-original-commit: 34d604ca89
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-28 18:02:06 +02:00
Loan (lse)
3e25d94b0d [IMP] outlook mail_plugin: add solution for cookie issue
closes odoo/documentation#1645

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-28 10:04:51 +02:00
Adrien Milis
b578f575d0 [FIX] developer/rd-training: fix commands
Changed commands that were still referring to Odoo 14.0 to 15.0

closes odoo/documentation#1868

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-26 16:40:48 +02:00
MichaSi
9693824bee [FIX] crm: fix typos and menuselection items
closes odoo/documentation#1183

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-26 11:22:56 +02:00
Antoine Vandevenne (anv)
d28fb186ae [FIX] developer/rdtraining: fix typos
closes odoo/documentation#1863

X-original-commit: f8f5ed93e1
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
2022-04-26 11:22:53 +02:00
2200 changed files with 7029 additions and 4105 deletions

2
.gitattributes vendored Normal file
View File

@@ -0,0 +1,2 @@
# Include RST files in language statistics on GitHub.
*.rst linguist-detectable

3
.gitignore vendored
View File

@@ -1,6 +1,7 @@
*.pyc
.*
*.mo
.*
!.gitattributes
# Sphinx build files
_build/

View File

@@ -19,6 +19,8 @@ SPHINXOPTS = -D project_root=$(ROOT) -D canonical_version=$(CANONICAL_VERSIO
-D versions=$(VERSIONS) -D languages=$(LANGUAGES) -D language=$(CURRENT_LANG) \
-D is_remote_build=$(IS_REMOTE_BUILD) \
-A google_analytics_key=$(GOOGLE_ANALYTICS_KEY) \
-A plausible_script=$(PLAUSIBLE_SCRIPT) \
-A plausible_domain=$(PLAUSIBLE_DOMAIN) \
-j $(WORKERS)
SOURCE_DIR = content

78
conf.py
View File

@@ -1,9 +1,12 @@
import re
import os
import shutil
import sys
from pathlib import Path
import docutils
from pygments.lexers import JsonLexer, XmlLexer
from sphinx.ext import graphviz
from sphinx.util import logging
import sphinx
@@ -53,6 +56,11 @@ add_function_parentheses = True
#=== Extensions configuration ===#
source_read_replace_vals = {
'GITHUB_PATH': f'https://github.com/odoo/odoo/blob/{version}',
'GITHUB_ENT_PATH': f'https://github.com/odoo/enterprise/blob/{version}',
}
# Add extensions directory to PYTHONPATH
extension_dir = Path('extensions')
sys.path.insert(0, str(extension_dir.absolute()))
@@ -74,11 +82,15 @@ if not odoo_sources_dirs:
{'dir_list': '\n'.join([f'\t- {d.resolve()}' for d in odoo_sources_candidate_dirs])},
)
else:
odoo_dir = odoo_sources_dirs[0].resolve()
sys.path.insert(0, str(odoo_dir))
if (3, 6) < sys.version_info < (3, 7):
# Running odoo needs python 3.7 min but monkey patch version_info to be compatible with 3.6
# Running odoo needs python 3.7 min but monkey patch version_info to be compatible with 3.6.
sys.version_info = (3, 7, 0)
odoo_dir = odoo_sources_dirs[0].resolve()
source_read_replace_vals['ODOO_RELPATH'] = '/../' + str(odoo_sources_dirs[0])
source_read_replace_vals['ODOO_ABSPATH'] = str(odoo_dir)
sys.path.insert(0, str(odoo_dir))
import odoo.addons
odoo.addons.__path__.append(str(odoo_dir) + '/addons')
from odoo import release as odoo_release # Don't collide with Sphinx's 'release' config option
odoo_version = odoo_release.version.replace('~', '-') \
if 'alpha' not in odoo_release.version else 'master'
@@ -98,12 +110,18 @@ else:
)
odoo_dir_in_path = True
# Mapping between odoo models related to master data and the declaration of the
# data. This is used to point users to available xml_ids when giving values for
# a field with the autodoc_field extension.
model_references = {
'account.account.type': 'addons/account/data/data_account_type.xml',
'res.country': 'odoo/addons/base/data/res_country_data.xml',
'res.currency': 'odoo/addons/base/data/res_currency_data.xml',
}
# The Sphinx extensions to use, as module names.
# They can be extensions coming with Sphinx (named 'sphinx.ext.*') or custom ones.
extensions = [
# Parse Python docstrings (autodoc, automodule, autoattribute directives)
'sphinx.ext.autodoc' if odoo_dir_in_path else 'autodoc_placeholder',
# Link sources in other projects (used to build the reference doc)
'sphinx.ext.intersphinx',
@@ -133,7 +151,15 @@ if odoo_dir_in_path:
extensions += [
'sphinx.ext.linkcode',
'github_link',
# Parse Python docstrings (autodoc, automodule, autoattribute directives)
'sphinx.ext.autodoc',
'autodoc_field',
]
else:
extensions += [
'autodoc_placeholder',
]
extensions.append('sphinx.ext.graphviz' if shutil.which('dot') else 'graphviz_placeholder')
todo_include_todos = False
@@ -225,7 +251,7 @@ latex_elements = {
'tableofcontents': '', # no TOC
# Output manually in latex docs
'releasename': '14.0',
'releasename': release,
}
latex_additional_files = ['static/latex/odoo.sty']
@@ -265,6 +291,22 @@ latex_logo = 'static/img/odoo_logo.png'
# If true, show URL addresses after external links.
latex_show_urls = 'True'
# https://github.com/sphinx-doc/sphinx/issues/4054#issuecomment-329097229
def source_read_replace(app, docname, source):
"""Substitute parts of strings with computed values.
Since the RST substitution is not working everywhere, i.e. in directives'
options, we need to be able to input those values when reading the sources.
This is using the config `source_read_replace_vals`, mapping a name to its
replacement. This will look for the name surrounded by curly braces in the source.
Meant to be connected to the `source-read` event.
"""
result = source[0]
for key in app.config.source_read_replace_vals:
result = result.replace(f"{{{key}}}", app.config.source_read_replace_vals[key])
source[0] = result
def setup(app):
# Generate all alternate URLs for each document
@@ -273,12 +315,34 @@ def setup(app):
app.add_config_value('versions', None, 'env')
app.add_config_value('languages', None, 'env')
app.add_config_value('is_remote_build', None, 'env') # Whether the build is remotely deployed
app.add_config_value('source_read_replace_vals', {}, 'env')
app.connect('source-read', source_read_replace)
app.add_lexer('json', JsonLexer)
app.add_lexer('xml', XmlLexer)
app.connect('html-page-context', _generate_alternate_urls)
# Add a `condition` option on directives to ignore them based on config values
app.add_config_value('odoo_dir_in_path', None, 'env')
def context_eval(expr):
return eval(expr, {confval.name: confval.value for confval in app.config})
def patch(to_patch):
to_patch.option_spec['condition'] = context_eval
original_run = to_patch.run
def new_run(self):
if not self.options.get('condition', True):
return []
return original_run(self)
to_patch.run = new_run
for to_patch in (
sphinx.directives.code.LiteralInclude,
docutils.parsers.rst.directives.tables.CSVTable,
):
patch(to_patch)
def _generate_alternate_urls(app, pagename, templatename, context, doctree):
""" Add keys of required alternate URLs for the current document in the rendering context.

View File

@@ -21,6 +21,11 @@ You can use a custom domain name to access your Odoo database and websites:
databases for one year. Visitors can then access your website with an address such as
``www.example.com`` rather than the default ``example.odoo.com``.
.. seealso::
- `Odoo Tutorials: Register a Free Domain Name
<https://www.odoo.com/slides/slide/register-a-free-domain-name-1663>`_
- `Odoo Quick Tips: Get a free domain name! <https://www.youtube.com/watch?v=eAfgeNOHLP4>`_
.. _domain-name/about:
About domain names

View File

@@ -232,6 +232,6 @@ Save the file and then run the Odoo Shell:
Finally, *via* the Odoo Shell, you can trigger the piece of code/function/method
you want to debug.
.. image:: ./media/pdb_sh.png
.. image:: containers/pdb_sh.png
:align: center
:alt: Console screenshot showing ``pdb`` running in an Odoo.sh shell.

View File

Before

Width:  |  Height:  |  Size: 72 KiB

After

Width:  |  Height:  |  Size: 72 KiB

View File

@@ -44,7 +44,7 @@ On Odoo.sh, in the branches view of your project, choose the branch in which you
In the upper right corner, click on the *Submodule* button, and then on *Run*.
.. image:: ./media/advanced-submodules-button.png
.. image:: submodules/advanced-submodules-button.png
:align: center
A dialog with a form is shown. Fill the inputs as follows:
@@ -53,12 +53,12 @@ A dialog with a form is shown. Fill the inputs as follows:
* Branch: The branch you want to use.
* Path: The folder in which you want to add this submodule in your branch.
.. image:: ./media/advanced-submodules-dialog.png
.. image:: submodules/advanced-submodules-dialog.png
:align: center
On Github, you can get the repository URL with the *Clone or download* button of the repository. Make sure to *use SSH*.
.. image:: ./media/advanced-submodules-github-sshurl.png
.. image:: submodules/advanced-submodules-github-sshurl.png
:align: center
.. _odoosh-advanced-submodules-withgit:

View File

@@ -8,7 +8,7 @@ Overview
The branches view gives you an overview of the different branches your repository has.
.. image:: ./media/interface-branches.png
.. image:: branches/interface-branches.png
:align: center
.. _odoosh-gettingstarted-branches-stages:
@@ -20,7 +20,7 @@ Odoo.sh offers three different stages for your branches: production, staging and
You can change the stage of a branch by drag and dropping it into the stage section title.
.. image:: ./media/interface-branches-stagechange.png
.. image:: branches/interface-branches-stagechange.png
:align: center
.. _stage_production:
@@ -109,7 +109,7 @@ Merging your branches
---------------------
You can merge your branches easily by drag and dropping them into each other.
.. image:: ./media/interface-branches-merge.png
.. image:: branches/interface-branches-merge.png
:align: center
When you want to test the changes of your development branches with the production data,
@@ -156,7 +156,7 @@ An overview of your branch history:
* The messages of the commits and their authors,
* The various events linked to the platform, such as stage changes, database imports, backup restores.
.. image:: ./media/interface-branches-history.png
.. image:: branches/interface-branches-history.png
:align: center
For each event, a status is displayed in the top right-hand corner.
@@ -172,7 +172,7 @@ This tab contains the mail catcher. It displays an overview of the emails sent b
The mail catcher is available for your development and
staging branches as the emails of your production database are really sent instead of being intercepted.
.. image:: ./media/interface-branches-mails.png
.. image:: branches/interface-branches-mails.png
:align: center
:scale: 50%
@@ -181,7 +181,7 @@ Shell
A shell access to your container. You can perform basic linux commands (:code:`ls`, :code:`top`)
and open a shell on your database by typing :code:`psql`.
.. image:: ./media/interface-branches-shell.png
.. image:: branches/interface-branches-shell.png
:align: center
You can open multiple tabs and drag-and-drop them to arrange the layout as you wish,
@@ -197,7 +197,7 @@ Editor
An online integrated development environment (IDE) to edit the source code.
You can also open terminals, Python consoles and even Odoo Shell consoles.
.. image:: ./media/interface-branches-editor.png
.. image:: branches/interface-branches-editor.png
:align: center
You can open multiple tabs and drag-and-drop them to arrange the layout as you wish,
@@ -207,7 +207,7 @@ Monitoring
----------
This link contains various monitoring metrics of the current build.
.. image:: ./media/interface-branches-monitoring.png
.. image:: branches/interface-branches-monitoring.png
:align: center
You can zoom, change the time range or select a specific metric on each graph.
@@ -219,7 +219,7 @@ Logs
----
A viewer to have a look to your server logs.
.. image:: ./media/interface-branches-logs.png
.. image:: branches/interface-branches-logs.png
:align: center
Different logs are available:
@@ -243,7 +243,7 @@ Backups
A list of the backups available for download and restore, the ability to perform a manual backup and to import a
database.
.. image:: ./media/interface-branches-backups.png
.. image:: branches/interface-branches-backups.png
:align: center
Odoo.sh makes daily backups of the production database. It keeps 7 daily, 4 weekly and 3 monthly backups.
@@ -285,7 +285,7 @@ Settings
--------
Here you can find a couple of settings that only apply to the currently selected branch.
.. image:: ./media/interface-branches-settings.jpg
.. image:: branches/interface-branches-settings.jpg
:align: center
**Behaviour upon new commit**
@@ -302,7 +302,7 @@ back from staging to development will automatically be set to 'Do nothing'.
Choose the modules to install automatically for your development builds.
.. image:: ./media/interface-settings-modulesinstallation.png
.. image:: branches/interface-settings-modulesinstallation.png
:align: center
* *Install only my modules* will install the modules of the branch only. This is the default option.
@@ -397,7 +397,7 @@ Shell commands
==============
In the top right-hand corner of the view, different shell commands are available.
.. image:: ./media/interface-branches-shellcommands.png
.. image:: branches/interface-branches-shellcommands.png
:align: center
Each command can be copied in the clipboard to be used in a terminal,
@@ -466,12 +466,12 @@ To do so, follow these steps:
(only apply the step 1)
#. Paste the copied content to your profile SSH keys and press "Add"
.. image:: ./media/SSH-key-pasting.png
.. image:: branches/SSH-key-pasting.png
:align: center
#. The key should appear below
.. image:: ./media/SSH-key-appearing.png
.. image:: branches/SSH-key-appearing.png
:align: center
Connection
@@ -485,7 +485,7 @@ To connect to your builds using ssh use the following command in a terminal:
You will find a shortcut for this command into the SSH tab in the upper right corner.
.. image:: ./media/SSH-panel.png
.. image:: branches/SSH-panel.png
:align: center
Provided you have the :ref:`correct access rights <odoosh-gettingstarted-settings-collaborators>` on the project,

View File

Before

Width:  |  Height:  |  Size: 4.7 KiB

After

Width:  |  Height:  |  Size: 4.7 KiB

View File

@@ -13,7 +13,7 @@ In Odoo.sh, a build is considered as a database loaded by an Odoo server
running on a specific revision of your project repository in a containerized environment.
Its purpose is to test the well-behavior of the server, the database and the features with this revision.
.. image:: ./media/interface-builds.png
.. image:: builds/interface-builds.png
:align: center
In this view, a row represents a branch, and a cell of a row represents a build of this branch.
@@ -95,7 +95,7 @@ Features
The production branch will always appear first,
and then the other branches are ordered by last build created. You can filter out the branches.
.. image:: ./media/interface-builds-branches.png
.. image:: builds/interface-builds-branches.png
:align: center
For each branch, you can access the last build's database using the *Connect* link and jump to the branch code using
@@ -103,7 +103,7 @@ the *Github* link. For other branches than the production, you can create a new
of the branch using the link *rebuild*. This last link is not available when there is already a build in progress for
the branch.
.. image:: ./media/interface-builds-build.png
.. image:: builds/interface-builds-build.png
:align: center
For each build, you can access the revision changes using the button with the Github icon.
@@ -113,7 +113,7 @@ in the dropdown menu of the *Connect* button.
.. _odoosh-gettingstarted-builds-download-dump:
.. image:: ./media/interface-builds-build-dropdown.png
.. image:: builds/interface-builds-build-dropdown.png
:align: center
.. _odoosh-gettingstarted-builds-dropdown-menu:

View File

@@ -10,7 +10,7 @@ Deploy your platform
Go to `Odoo.sh <https://www.odoo.sh/>`_ and hit the *Deploy your platform* button.
.. image:: ./media/deploy.png
.. image:: create/deploy.png
:align: center
Sign in with Github
@@ -18,7 +18,7 @@ Sign in with Github
Sign in with your Github account. If you do not have an account yet, hit the *Create an account* link.
.. image:: ./media/github-signin.png
.. image:: create/github-signin.png
:align: center
Authorize Odoo.sh
@@ -26,7 +26,7 @@ Authorize Odoo.sh
Grant Odoo.sh the required accesses to your account by clicking the *Authorize* button.
.. image:: ./media/github-authorize.png
.. image:: create/github-authorize.png
:align: center
Odoo.sh basically needs:
@@ -62,7 +62,7 @@ When submitting the form, if you are notified your subscription is not valid, it
In case of doubt with your subscription, please contact the `Odoo support <https://www.odoo.com/help>`_.
.. image:: ./media/deploy-form.png
.. image:: create/deploy-form.png
:align: center
You're done !
@@ -70,7 +70,7 @@ You're done !
You can start using Odoo.sh. Your first build is about to be created. You will soon be able to connect to your first database.
.. image:: ./media/deploy-done.png
.. image:: create/deploy-done.png
:align: center
.. _odoo_sh_import_your_database:
@@ -113,12 +113,12 @@ Access the URL :file:`/web/database/manager` of your on-premise database and dow
You will need the master password of your database server. If you do not have it, contact your system administrator.
.. image:: ./media/create-import-onpremise-backup.png
.. image:: create/create-import-onpremise-backup.png
:align: center
Choose a zip including the filestore as the backup format.
.. image:: ./media/create-import-onpremise-backup-dialog.png
.. image:: create/create-import-onpremise-backup-dialog.png
:align: center
Odoo Online databases
@@ -126,7 +126,7 @@ Odoo Online databases
`Access your databases manager <https://accounts.odoo.com/my/databases/manage>`_ and download a backup of your database.
.. image:: ./media/create-import-online-backup.png
.. image:: create/create-import-online-backup.png
:align: center
.. Warning::
@@ -138,12 +138,12 @@ Upload the backup
Then, in your Odoo.sh project, in the backups tab of your production branch, import the backup you just downloaded.
.. image:: ./media/create-import-production.png
.. image:: create/create-import-production.png
:align: center
Once the backup imported, you can access the database using the *Connect* button in the history of the branch.
.. image:: ./media/create-import-production-done.png
.. image:: create/create-import-production-done.png
:align: center
Check your outgoing email servers

View File

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

View File

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 29 KiB

View File

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 34 KiB

View File

@@ -37,20 +37,20 @@ In the branches view:
|pic1| |pic2|
.. |pic1| image:: ./media/firstmodule-development-+.png
.. |pic1| image:: first_module/firstmodule-development-+.png
:width: 45%
.. |pic2| image:: ./media/firstmodule-development-fork.png
.. |pic2| image:: first_module/firstmodule-development-fork.png
:width: 45%
Once the build created, you can access the editor and browse to the folder *~/src/user* to access
to the code of your development branch.
.. image:: ./media/firstmodule-development-editor.png
.. image:: first_module/firstmodule-development-editor.png
:align: center
.. image:: ./media/firstmodule-development-editor-interface.png
.. image:: first_module/firstmodule-development-editor-interface.png
:align: center
From your computer
@@ -95,7 +95,7 @@ Or, from your computer, if you have an :ref:`installation of Odoo <setup/install
$ ./odoo-bin scaffold my_module ~/src/odoo-addons/
If you do not want to bother installing Odoo on your computer,
you can also :download:`download this module structure template <media/my_module.zip>` in which you replace every occurrences of
you can also :download:`download this module structure template <first_module/my_module.zip>` in which you replace every occurrences of
*my_module* to the name of your choice.
The below structure will be generated:
@@ -201,19 +201,19 @@ Test your module
Your branch should appear in your development branches in your project.
.. image:: ./media/firstmodule-test-branch.png
.. image:: first_module/firstmodule-test-branch.png
:align: center
In the branches view of your project,
you can click on your branch name in the left navigation panel to access its history.
.. image:: ./media/firstmodule-test-branch-history.png
.. image:: first_module/firstmodule-test-branch-history.png
:align: center
You can see here the changes you just pushed, including the comment you set.
Once the database ready, you can access it by clicking the *Connect* button.
.. image:: ./media/firstmodule-test-database.png
.. image:: first_module/firstmodule-test-database.png
:align: center
If your Odoo.sh project is configured to install your module automatically,
@@ -234,12 +234,12 @@ You can either:
* Make your development branch a staging branch, by drag and dropping it onto the *staging* section title.
.. image:: ./media/firstmodule-test-devtostaging.png
.. image:: first_module/firstmodule-test-devtostaging.png
:align: center
* Merge it in an existing staging branch, by drag and dropping it onto the given staging branch.
.. image:: ./media/firstmodule-test-devinstaging.png
.. image:: first_module/firstmodule-test-devinstaging.png
:align: center
You can also use the :code:`git merge` command to merge your branches.
@@ -247,7 +247,7 @@ You can also use the :code:`git merge` command to merge your branches.
This will create a new staging build, which will duplicate the production database and make it run using a server
updated with your latest changes of your branch.
.. image:: ./media/firstmodule-test-mergedinstaging.png
.. image:: first_module/firstmodule-test-mergedinstaging.png
:align: center
Once the database ready, you can access it using the *Connect* button.
@@ -267,12 +267,12 @@ Your module may not appear directly in your apps to install either, you need to
* in the apps menu, click the *Update Apps List* button,
* in the dialog that appears, click the *Update* button.
.. image:: ./media/firstmodule-test-updateappslist.png
.. image:: first_module/firstmodule-test-updateappslist.png
:align: center
Your module will then appear in the list of available apps.
.. image:: ./media/firstmodule-test-mymoduleinapps.png
.. image:: first_module/firstmodule-test-mymoduleinapps.png
:align: center
Deploy in production
@@ -283,7 +283,7 @@ and believe it is ready for production, you can merge your branch in the product
Drag and drop your staging branch on the production branch.
.. image:: ./media/firstmodule-test-mergeinproduction.png
.. image:: first_module/firstmodule-test-mergeinproduction.png
:align: center
You can also use the :code:`git merge` command to merge your branches.
@@ -291,7 +291,7 @@ You can also use the :code:`git merge` command to merge your branches.
This will merge the latest changes of your staging branch in the production branch,
and update your production server with these latest changes.
.. image:: ./media/firstmodule-test-mergedinproduction.png
.. image:: first_module/firstmodule-test-mergedinproduction.png
:align: center
Once the database ready, you can access it using the *Connect* button.
@@ -411,7 +411,7 @@ Or, from your computer terminal:
The platform will then create a new build for the branch *feature-1*.
.. image:: ./media/firstmodule-test-addachange-build.png
.. image:: first_module/firstmodule-test-addachange-build.png
:align: center
Once you tested your changes, you can merge your changes in the production branch, for instance by drag-and-dropping the

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.6 KiB

View File

@@ -12,7 +12,7 @@ The online editor allows you to edit the source code of your builds from a web b
It also gives you the possibility to open terminals, Python consoles, Odoo Shell consoles and
`Notebooks <https://jupyterlab.readthedocs.io/en/stable/user/notebook.html>`_.
.. image:: ./media/interface-editor.png
.. image:: online-editor/interface-editor.png
:align: center
You can access the editor of a build through
@@ -66,20 +66,20 @@ server is not a good practice.
To open a file in the editor, just double-click on it in the file browser panel on the left.
.. image:: ./media/interface-editor-open-file.png
.. image:: online-editor/interface-editor-open-file.png
:align: center
You can then begin to make your changes. You can save your changes with the menu
:menuselection:`File --> Save .. File` or by hitting the :kbd:`Ctrl+S` shortcut.
.. image:: ./media/interface-editor-save-file.png
.. image:: online-editor/interface-editor-save-file.png
:align: center
If you save a Python file which is under your Odoo server addons path,
Odoo will detect it and reload automatically so your changes are reflected immediately,
without having to restart the server manually.
.. image:: ./media/interface-editor-automaticreload.gif
.. image:: online-editor/interface-editor-automaticreload.gif
:align: center
However, if the change is a data stored in database, such as the label of a field, or a view,
@@ -88,7 +88,7 @@ You can update the module of the currently opened file by using the menu
:menuselection:`Odoo --> Update current module`. Note that the file considered as currently opened
is the file focused in the text editor, not the file highlighted in the file browser.
.. image:: ./media/interface-editor-update-current-module.png
.. image:: online-editor/interface-editor-update-current-module.png
:align: center
You can also open a terminal and execute the command:
@@ -118,7 +118,7 @@ In this last command,
* <branch> must be replaced by the name of the branch to which you want to push the changes,
most-likely the current branch if you work in a development build.
.. image:: ./media/interface-editor-commit-push.png
.. image:: online-editor/interface-editor-commit-push.png
:align: center
.. Note::
@@ -160,7 +160,7 @@ Thanks to this, you will be able to display objects in HTML.
You can for instance display cells of a CSV file using
`pandas <https://pandas.pydata.org/pandas-docs/stable/tutorials.html>`_.
.. image:: ./media/interface-editor-console-python-read-csv.png
.. image:: online-editor/interface-editor-console-python-read-csv.png
:align: center
You can also open an Odoo Shell console to play around
@@ -189,12 +189,12 @@ to easily display lists and dicts in a pretty way, using the
`rich display <https://ipython.readthedocs.io/en/stable/config/integrating.html#rich-display>`_
mentioned above.
.. image:: ./media/interface-editor-console-odoo-pretty.png
.. image:: online-editor/interface-editor-console-odoo-pretty.png
:align: center
You can also use
`pandas <https://pandas.pydata.org/pandas-docs/stable/tutorials.html>`_
to display graphs.
.. image:: ./media/interface-editor-console-odoo-graph.png
.. image:: online-editor/interface-editor-console-odoo-graph.png
:align: center

View File

@@ -8,7 +8,7 @@ Overview
The settings allow you to manage the configuration of your project.
.. image:: ./media/interface-settings.png
.. image:: settings/interface-settings.png
:align: center
Project name
@@ -16,7 +16,7 @@ Project name
The name of your project.
.. image:: ./media/interface-settings-projectname.png
.. image:: settings/interface-settings-projectname.png
:align: center
This defines the address that will be used to access your production database.
@@ -31,7 +31,7 @@ Collaborators
Manage the Github users who can access your project.
.. image:: ./media/interface-settings-collaborators.png
.. image:: settings/interface-settings-collaborators.png
:align: center
There are two levels of users:
@@ -87,7 +87,7 @@ Public Access
Allow public access to your development builds.
.. image:: ./media/interface-settings-public.png
.. image:: settings/interface-settings-public.png
:align: center
If activated, this option exposes the Builds page publicly, allowing visitors to connect to your development builds.
@@ -117,7 +117,7 @@ as submodules in your branches to allow Odoo.sh to download them.
If you are looking on how to set up your submodules,
instructions are available in the chapter :ref:`Submodules <odoosh-advanced-submodules>` of this documentation.
.. image:: ./media/interface-settings-submodules.png
.. image:: settings/interface-settings-submodules.png
:align: center
When a repository is private, it is not possible to publicly download its branches and revisions.
@@ -148,7 +148,7 @@ Storage Size
This section shows the storage size used by your project.
.. image:: ./media/interface-settings-storage.png
.. image:: settings/interface-settings-storage.png
:align: center
Storage size is computed as follows:
@@ -170,7 +170,7 @@ Additional database workers can be configured here. More workers help increase t
production database is able to handle. If you add more, it will automatically be synchronized
with your subscription.
.. image:: ./media/interface-settings-workers.png
.. image:: settings/interface-settings-workers.png
:align: center
.. Warning::
@@ -185,7 +185,7 @@ Staging Branches
Additional staging branches allow you to develop and test more features at the same time. If you
add more, it will automatically be synchronized with your subscription.
.. image:: ./media/interface-settings-staging-branches.png
.. image:: settings/interface-settings-staging-branches.png
:align: center
Activation
@@ -193,5 +193,5 @@ Activation
Shows the status of the project's activation. You can change the project's activation code if needed.
.. image:: ./media/interface-settings-activation.png
.. image:: settings/interface-settings-activation.png
:align: center

View File

@@ -8,5 +8,5 @@ Overview
The status page shows statistics regarding the servers your project uses. It includes the servers availability.
.. image:: ./media/interface-status.png
.. image:: status/interface-status.png
:align: center

View File

@@ -1,8 +1,8 @@
:nosearch:
===========
Bank & Cash
===========
=============
Bank and cash
=============
.. toctree::
:titlesonly:

View File

@@ -1,7 +1,7 @@
:nosearch:
==========
Bank Feeds
Bank feeds
==========
.. toctree::

View File

@@ -1,5 +1,5 @@
===============
Bank Statements
Bank statements
===============
Importing your bank statements in Odoo Accounting allows you to keep track of the financial
@@ -29,7 +29,7 @@ Odoo supports multiple file formats to import bank statements:
To import them, go to :menuselection:`Accounting --> Overview --> Bank`, click on *Import
Statements*, or on the three dots, and then on *Import Statement*.
.. image:: media/bank-statements-01.png
.. image:: bank_statements/bank-statements-01.png
:align: center
:alt: Import a bank statement file in Odoo Accounting
@@ -38,7 +38,7 @@ Next, select the file you want to import and click on *Import*.
Odoo opens an **import widget** to help you set the **Formatting Options** and **map** the
different columns you want to import.
.. image:: media/bank-statements-02.png
.. image:: bank_statements/bank-statements-02.png
:align: center
:alt: Register bank statements manually in Odoo Accounting
@@ -59,7 +59,7 @@ Add a new line for each transaction written on the original bank statement.
To ease the reconciliation process, make sure to fill out the *Partner* field. You can also write
the payments references in the *Label* field.
.. image:: media/bank-statements-03.png
.. image:: bank_statements/bank-statements-03.png
:align: center
:alt: Register bank statements manually in Odoo Accounting

View File

@@ -1,5 +1,5 @@
======================================
Bank Synchronization: Automatic Import
Bank synchronization: Automatic import
======================================
Odoo can synchronize directly with your bank institution to get all bank statements imported
@@ -8,7 +8,7 @@ automatically into your database.
To check if your bank is compatible with Odoo, go to `Odoo Accounting Features
<https://www.odoo.com/page/accounting-features>`_, and click on *See list of supported institutions*.
.. image:: media/online-sync-doc.png
.. image:: bank_synchronization/online-sync-doc.png
:align: center
:alt: Checking a bank's compatibility with Odoo
@@ -68,14 +68,14 @@ After your first synchronization, the created journals are synchronized by defau
If you wish, you can synchronize manually by clicking on the *Synchronize Now* button on the
dashboard.
.. image:: media/online-sync-sync-now-dashboard.png
.. image:: bank_synchronization/online-sync-sync-now-dashboard.png
:align: center
:alt: Synchronize Now Button
Or you can go to :menuselection:`Accounting --> Configuration --> Online Synchronization`,
select your institution and then click on the *Fetch Transactions* button.
.. image:: media/online-sync-form-view.png
.. image:: bank_synchronization/online-sync-form-view.png
:align: center
:alt: Online Synchronization Form view
@@ -121,7 +121,7 @@ To do so, go to :menuselection:`Apps --> Update Apps List`, remove the default f
bar and type: **account_online_synchronization**. You can then click on the *Install* button to
install the new module.
.. image:: media/online-sync-module.png
.. image:: bank_synchronization/online-sync-module.png
:align: center
:alt: Installation button of the account_online_synchronization module

View File

@@ -6,7 +6,7 @@ Ponto as bank synchronization provider
place and directly see all their transactions within one app. It is a third-party solution that is
continuously expanding the number of bank institutions that can be synchronized with Odoo.
.. image:: media/ponto-logo.png
.. image:: ponto/ponto-logo.png
:align: center
:alt: Logo of the Ponto brand
@@ -30,7 +30,7 @@ Link your bank accounts with Ponto
#. Create an account if you don't have one yet.
#. Once you are logged in, create an *organization*.
.. image:: media/ponto-organization.png
.. image:: ponto/ponto-organization.png
:align: center
:alt: Fill out the form to add an organization in Ponto.
@@ -39,7 +39,7 @@ Link your bank accounts with Ponto
#. Select your country, your bank institutions, give your consent to Ponto, and follow the steps
on-screen to link your bank account with your Ponto account.
.. image:: media/ponto-add-account.png
.. image:: ponto/ponto-add-account.png
:align: center
:alt: Add bank accounts to your Ponto account.
@@ -57,7 +57,7 @@ Link your Ponto account with your Odoo database
**all the accounts** you want to synchronize. Even the ones coming from other banking
institutions.
.. image:: media/ponto-select-accounts.png
.. image:: ponto/ponto-select-accounts.png
:align: center
:alt: Selection of the accounts you wish to synchronize with Odoo.

Some files were not shown because too many files have changed in this diff Show More