summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristophe Simonis <chs@odoo.com>2018-02-01 16:40:13 +0100
committerChristophe Simonis <chs@odoo.com>2018-02-01 16:40:13 +0100
commit920aa6174c938bbfc0864a95ff3d8ebbe3132387 (patch)
treea1bd8f8871cba6af086607d94842a4f5e53fbbbe /doc
parenteeebd4ad857fec39c14abc0a0e387c13adcfa30b (diff)
parente0422bfd6c528313ee399dad3e67407360d49725 (diff)
[MERGE] forward port branch saas-15 up to e0422bfd6c5
Diffstat (limited to 'doc')
-rw-r--r--doc/cla/individual/moutio.md9
-rw-r--r--doc/reference/module.rst45
2 files changed, 52 insertions, 2 deletions
diff --git a/doc/cla/individual/moutio.md b/doc/cla/individual/moutio.md
new file mode 100644
index 00000000000..4a1b5b4b955
--- /dev/null
+++ b/doc/cla/individual/moutio.md
@@ -0,0 +1,9 @@
+Spain, 2018-01-29
+
+I hereby agree to the terms of the Odoo Individual Contributor License Agreement v1.0.
+
+I declare that I am authorized and able to make this agreement and sign this declaration.
+
+Signed,
+
+Nacho Muñoz nacmuro@gmail.com https://github.com/moutio
diff --git a/doc/reference/module.rst b/doc/reference/module.rst
index aecb8de8a8f..9ec0ef39c93 100644
--- a/doc/reference/module.rst
+++ b/doc/reference/module.rst
@@ -1,5 +1,3 @@
-:banner: banners/module.jpg
-
=======
Modules
=======
@@ -84,6 +82,49 @@ Available manifest fields are:
to ``auto_install``. When both ``sale`` and ``crm`` are installed, it
automatically adds CRM campaigns tracking to sale orders without either
``sale`` or ``crm`` being aware of one another
+``external_dependencies`` (``dict(key=list(str))``)
+ A dictionary containing python and/or binary dependencies.
+
+ For python dependencies, the ``python`` key must be defined for this
+ dictionary and a list of python modules to be imported should be assigned
+ to it.
+
+ For binary dependencies, the ``bin`` key must be defined for this
+ dictionary and a list of binary executable names should be assigned to it.
+
+ The module won't be installed if either the python module is not installed
+ in the host machine or the binary executable is not found within the
+ host machine's PATH environment variable.
+``application`` (``bool``, default: ``False``)
+ Whether the module should be considered as a fully-fledged application
+ (``True``) or is just a technical module (``False``) that provides some
+ extra functionality to an existing application module.
+``css`` (``list(str)``)
+ Specify css files with custom rules to be imported, these files should be
+ located in ``static/src/css`` inside the module.
+``images`` (``list(str)``)
+ Specify image files to be used by the module.
+``installable`` (``bool`` default: ``False``)
+ Whether a user should be able to install the module from the Web UI or not.
+``maintainer`` (``str``)
+ Person or entity in charge of the maintenance of this module, by default
+ it is assumed that the author is the maintainer.
+``{pre_init, post_init, uninstall}_hook`` (``str``)
+ Hooks for module installation/uninstallation, their value should be a
+ string representing the name of a function defined inside the module's
+ ``__init__.py``.
+
+ ``pre_init_hook`` takes a cursor as its only argument, this function is
+ executed prior to the module's installation.
+
+ ``post_init_hook`` takes a cursor and a registry as its arguments, this
+ function is executed right after the module's installation.
+
+ ``uninstall_hook`` takes a cursor and a registry as its arguments, this
+ function is executed after the module's uninstallation.
+
+ These hooks should only be used when setup/cleanup required for this module
+ is either extremely difficult or impossible through the api.
.. _semantic versioning: http://semver.org
.. _existing categories: