~therp-nl/anybox.recipe.openerp/jbaudoux-relative_paths_resolve_conflict

« back to all changes in this revision

Viewing changes to doc/index.rst

[MRG] Update with target branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.. OpenERP buildout recipe documentation master file, created by
 
2
   sphinx-quickstart on Wed Jul 24 18:32:19 2013.
 
3
   You can adapt this file completely to your liking, but it should at least
 
4
   contain the root `toctree` directive.
 
5
 
 
6
OpenERP buildout recipe
 
7
=======================
 
8
 
 
9
This recipe for `Buildout <https://github.com/buildout/buildout>`_ is
 
10
a fully featured tool allowing you to define and deploy quickly
 
11
OpenERP installations of any kinds, ranging from development setups to
 
12
fully automated production deployments or continuous integration.
 
13
 
 
14
Some of its main features include:
 
15
 
 
16
* uniformity across OpenERP versions (from 5.0 onwards)
 
17
* installation of OpenERP server and, if meaningful, GTK and web clients.
 
18
* retrieval of main software and addons from various sources,
 
19
  including the major version control systems
 
20
* ability to pinpoint everything for replayability
 
21
* management of OpenERP configuration
 
22
* dedicated scripts creation for easy integration of external tools,
 
23
  such as test launchers
 
24
* packaging: creation of self-contained equivalents for easy
 
25
  deployment in tightly controlled hosting environmenents.
 
26
 
 
27
All these to be considered together with zc.buildout‘s general
 
28
properties, such as an extensible configuration file format for easy
 
29
variation or separation of concerns, native Python distributions
 
30
installation, and of course the huge ecosystem of other recipes.
 
31
 
 
32
About this documentation
 
33
------------------------
 
34
 
 
35
The full documentation is written with `Sphinx
 
36
<http://sphinx-doc.org>`_, built continuously and
 
37
uploaded to http://docs.anybox.fr/anybox.recipe.openerp/trunk by Anybox' public
 
38
buildbot.
 
39
The Sphinx source tree is to be found under the ``doc`` subdirectory
 
40
of this project.
 
41
 
 
42
Although this Sphinx documentation started with version 1.8.0, most of
 
43
its contents applies to the 1.7 series: features introduced with 1.8
 
44
are highlighted, and readers may consult the `changelog on PyPI
 
45
<https://pypi.python.org/pypi/anybox.recipe.openerp#changes>`_.
 
46
 
 
47
We plan to upload released versions of the documentation to
 
48
http://pythonhosted.org
 
49
 
 
50
Contents
 
51
--------
 
52
 
 
53
.. toctree::
 
54
   :maxdepth: 2
 
55
   :glob:
 
56
 
 
57
   first_steps
 
58
   configuration
 
59
   scripts
 
60
   dev_prod_workflow
 
61
   contributing
 
62
 
 
63
Code documentation
 
64
------------------
 
65
 
 
66
.. toctree::
 
67
   :maxdepth: 1
 
68
   :glob:
 
69
 
 
70
   apidoc/anybox*
 
71
 
 
72
 
 
73
Indices and tables
 
74
------------------
 
75
 
 
76
* :ref:`genindex`
 
77
* :ref:`modindex`
 
78
* :ref:`search`
 
79