README

   1 ======================================
   2 dbus-python: Python bindings for D-Bus
   3 ======================================
   4
   5 :Author: Simon McVittie, `Collabora`_
   6 :Date: 2006-12-18
   7
   8 .. Collabora: http://www.collabora.co.uk/
   9
  10 Usage
  11 =====
  12
  13 For client code, see the docstring for dbus/__init__.py.
  14
  15 To export objects, see the docstring for dbus/service.py.
  16
  17 To develop on dbus-python, see HACKING.txt.
  18
  19 Building the API documentation
  20 ==============================
  21
  22 Because the API documentation is generated with a pre-release version of
  23 epydoc, it's not currently built by default. To do so, install
  24 `epydoc`_ 3 alpha and `docutils`_, and run ``./configure`` with the
  25 ``--enable-api-docs`` option. Documentation starts from ``api/index.html``.
  26
  27 .. epydoc: http://epydoc.sourceforge.net/
  28 .. python-docutils: http://docutils.sourceforge.net/
  29
  30 For now, a copy of the documentation (updated for each release candidate)
  31 can be found here: `dbus-python API documentation on people.freedesktop.org`__
  32
  33 __ http://people.freedesktop.org/~smcv/dbus-python-0.8pre/epydoc/