README

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