~ubuntu-branches/ubuntu/saucy/click/saucy-proposed

« back to all changes in this revision

Viewing changes to doc/index.rst

  • Committer: Package Import Robot
  • Author(s): Colin Watson
  • Date: 2013-06-27 15:57:25 UTC
  • Revision ID: package-import@ubuntu.com-20130627155725-1kpggp0xots3peir
Tags: 0.1.3
Rename to click, per Mark Shuttleworth.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.. Click Packages documentation master file, created by
 
2
   sphinx-quickstart on Mon Apr 15 11:34:57 2013.
 
3
   You can adapt this file completely to your liking, but it should at least
 
4
   contain the root `toctree` directive.
 
5
 
 
6
==============
 
7
Click packages
 
8
==============
 
9
 
 
10
*Click* is the code name used to describe a packaging format for Ubuntu mobile
 
11
applications.  This format specifies how individual apps are delivered to
 
12
mobile devices, how they are packed into distributable format, and how they
 
13
are installed on a mobile device by a system provided package manager.  At a
 
14
minimum they assume that a system framework exists providing all the
 
15
necessary infrastructure and dependencies needed in order to install and run
 
16
such apps.
 
17
 
 
18
The click packaging format is completely independent from facilities to do
 
19
full-system installations or upgrades.
 
20
 
 
21
 
 
22
Compatibility
 
23
=============
 
24
 
 
25
Currently, this package should remain compatible with Python 2.7 and 3.3.
 
26
 
 
27
 
 
28
Dependencies
 
29
------------
 
30
 
 
31
For Ubuntu 13.04, make sure you have the *python2.7* and *python3.3* packages
 
32
installed.
 
33
 
 
34
You'll need *gcc* in order to build the preload shared library.  Assuming you
 
35
have this, do the following::
 
36
 
 
37
    $ (cd preload && make)
 
38
 
 
39
You'll need *tox* (Ubuntu package *python-tox*) installed in order to run the
 
40
full test suite.  You should be able to just say::
 
41
 
 
42
    $ tox
 
43
 
 
44
to run the full suite.  Use tox's ``-e`` option to run the tests against a
 
45
subset of Python versions.  You shouldn't have to install anything manually
 
46
into the virtual environments that tox creates, but you might have to if you
 
47
don't have all the dependencies installed in your system Pythons.
 
48
 
 
49
You'll need the *mock* and *python-debian* libraries.  For Ubuntu 13.04,
 
50
apt-get install the following packages::
 
51
 
 
52
 * python-mock
 
53
 * python-debian
 
54
 * python3-debian
 
55
 
 
56
 
 
57
Testing
 
58
=======
 
59
 
 
60
After all of the above is installed, you can run ``tox`` to run the test suite
 
61
against all supported Python versions.  The ``./run-tests`` scripts just does
 
62
an additional check to make sure you've got the preload shared library
 
63
built.
 
64
 
 
65
 
 
66
Documentation
 
67
=============
 
68
 
 
69
To build the HTML version of the documentation, you'll need Sphinx (Ubuntu
 
70
package *python-sphinx*).  Then do::
 
71
 
 
72
    $ (cd doc && make html)
 
73
 
 
74
 
 
75
Contents:
 
76
 
 
77
.. toctree::
 
78
   :maxdepth: 2
 
79
 
 
80
   file-format.rst
 
81
   constraints.rst
 
82
   hooks.rst
 
83
   todo.rst
 
84
 
 
85
 
 
86
Indices and tables
 
87
==================
 
88
 
 
89
* :ref:`genindex`
 
90
* :ref:`modindex`
 
91
* :ref:`search`