README

   1 =======================================
   2 dbus-python_: Python bindings for D-Bus
   3 =======================================
   4
   5 .. _dbus-python: http://www.freedesktop.org/wiki/Software/DBusBindings#python
   6
   7 Usage
   8 =====
   9
  10 Online documentation can be found at
  11 <http://dbus.freedesktop.org/doc/dbus-python/>.
  12
  13 There is an incomplete tutorial in `doc/tutorial.txt`__
  14 (if you compile dbus-python with ``rst2html`` installed or you're reading
  15 this document on the D-Bus website, there's also an `HTML version`__).
  16
  17 __ doc/tutorial.txt
  18 __ doc/tutorial.html
  19
  20 For client code, see the docstring for dbus/__init__.py.
  21
  22 To export objects, see the docstring for dbus/service.py.
  23
  24 To develop on dbus-python, see `doc/HACKING.txt`__ or the `HTML version`__.
  25
  26 __ doc/HACKING.txt
  27 __ doc/HACKING.html
  28
  29 Building the API documentation
  30 ==============================
  31
  32 Because the API documentation is generated with a pre-release version of
  33 epydoc, it's not currently built by default. To do so, install
  34 `epydoc`_ 3 alpha and `docutils`_, and run ``./configure`` with the
  35 ``--enable-api-docs`` option. Documentation starts from ``api/index.html``.
  36
  37 .. _epydoc: http://epydoc.sourceforge.net/
  38 .. _docutils: http://docutils.sourceforge.net/
  39
  40 A copy of the documentation can be found here:
  41 `dbus-python API documentation on people.freedesktop.org`__
  42
  43 __ http://dbus.freedesktop.org/doc/dbus-python/api/