summaryrefslogtreecommitdiff
path: root/README
blob: f24cdc569bdd1c2220ba11248b27aa0c5b6db5a7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
======================================
dbus-python: Python bindings for D-Bus
======================================

:Author: Simon McVittie, `Collabora`_
:Date: 2006-12-18
:Version: 0.80rc3 (internally, 0.79.93)

.. _Collabora: http://www.collabora.co.uk/

Usage
=====

For client code, see the docstring for dbus/__init__.py.

To export objects, see the docstring for dbus/service.py.

To develop on dbus-python, see HACKING.txt.

Building the API documentation
==============================

Because the API documentation is generated with a pre-release version of
epydoc, it's not currently built by default. To do so, install
`epydoc`_ 3 alpha and `docutils`_, and run ``./configure`` with the
``--enable-api-docs`` option. Documentation starts from ``api/index.html``.

.. _epydoc: http://epydoc.sourceforge.net/
.. _docutils: http://docutils.sourceforge.net/

For now, a copy of the documentation (updated for each release candidate)
can be found here: `dbus-python API documentation on people.freedesktop.org`__

__ http://people.freedesktop.org/~smcv/dbus-python-0.8pre/epydoc/