summaryrefslogtreecommitdiff
path: root/doc/reference
diff options
context:
space:
mode:
authorAntoine Vandevenne (anv) <anv@odoo.com>2019-09-13 11:48:44 +0000
committerAntoine Vandevenne (anv) <anv@odoo.com>2019-09-20 13:00:43 +0000
commit06915120ab0626ce92857e4eae25578f41eeb355 (patch)
tree9a1420d65e2cc9fafc6fdc9d1fa40fd11e4e4a71 /doc/reference
parent3431d7b1cd5fd1650855445604610fc7520aae0b (diff)
[IMP] doc: rewrite of the source install page
Prior to this commit, the documentation page for the installation of Odoo had lots of inconsistencies, errouneous information and a bad structure. This commit restructures the page to split the Source Install chapter into three sections for Windows, Linux and Mac OS. Each section is entirely rewritten to be accurate, logical, clean, easy to understand and focused on its purpose (removed tutorials of non-Odoo softwares). task-2072822 closes odoo/odoo#37001 Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Diffstat (limited to 'doc/reference')
-rw-r--r--doc/reference/cmdline.rst102
1 files changed, 52 insertions, 50 deletions
diff --git a/doc/reference/cmdline.rst b/doc/reference/cmdline.rst
index ddbe50a2b33..e954a5922df 100644
--- a/doc/reference/cmdline.rst
+++ b/doc/reference/cmdline.rst
@@ -442,56 +442,6 @@ Multiprocessing
For multi-processing mode, this is in addition to the HTTP worker processes.
-.. _reference/cmdline/scaffold:
-
-Scaffolding
-===========
-
-.. program:: odoo-bin scaffold
-
-Scaffolding is the automated creation of a skeleton structure to simplify
-bootstrapping (of new modules, in the case of Odoo). While not necessary it
-avoids the tedium of setting up basic structures and looking up what all
-starting requirements are.
-
-Scaffolding is available via the :command:`odoo-bin scaffold` subcommand.
-
-.. option:: name (required)
-
- the name of the module to create, may munged in various manners to
- generate programmatic names (e.g. module directory name, model names, …)
-
-.. option:: destination (default=current directory)
-
- directory in which to create the new module, defaults to the current
- directory
-
-.. option:: -t <template>
-
- a template directory, files are passed through jinja2_ then copied to
- the ``destination`` directory
-
-.. code-block:: console
-
- $ odoo_bin scaffold my_module /addons/
-
-This will create module *my_module* in directory */addons/*.
-
-Shell
-=====
-
-Odoo command-line also allows to launch odoo as a python console environment.
-This enables direct interaction with the :ref:`orm <reference/orm>` and its functionalities.
-
-
-.. code-block:: console
-
- $ odoo_bin shell
-
-.. option:: --shell-interface (ipython|ptpython|bpython|python)
-
- Specify a preferred REPL to use in shell mode.
-
.. _reference/cmdline/config:
Configuration file
@@ -534,3 +484,55 @@ to that file.
.. _Werkzeug's proxy support:
http://werkzeug.pocoo.org/docs/contrib/fixers/#werkzeug.contrib.fixers.ProxyFix
.. _pyinotify: https://github.com/seb-m/pyinotify/wiki
+
+
+Shell
+=====
+
+Odoo command-line also allows to launch odoo as a python console environment.
+This enables direct interaction with the :ref:`orm <reference/orm>` and its functionalities.
+
+
+.. code-block:: console
+
+ $ odoo_bin shell
+
+.. option:: --shell-interface (ipython|ptpython|bpython|python)
+
+ Specify a preferred REPL to use in shell mode.
+
+
+.. _reference/cmdline/scaffold:
+
+Scaffolding
+===========
+
+.. program:: odoo-bin scaffold
+
+Scaffolding is the automated creation of a skeleton structure to simplify
+bootstrapping (of new modules, in the case of Odoo). While not necessary it
+avoids the tedium of setting up basic structures and looking up what all
+starting requirements are.
+
+Scaffolding is available via the :command:`odoo-bin scaffold` subcommand.
+
+.. option:: name (required)
+
+ the name of the module to create, may munged in various manners to
+ generate programmatic names (e.g. module directory name, model names, …)
+
+.. option:: destination (default=current directory)
+
+ directory in which to create the new module, defaults to the current
+ directory
+
+.. option:: -t <template>
+
+ a template directory, files are passed through jinja2_ then copied to
+ the ``destination`` directory
+
+.. code-block:: console
+
+ $ odoo_bin scaffold my_module /addons/
+
+This will create module *my_module* in directory */addons/*. \ No newline at end of file