Update NEWS
[dbus-python-phuang.git] / README
blob479d48f5ae70f977c4f6392b39760e565194399a
1 =======================================
2 dbus-python_: Python bindings for D-Bus
3 =======================================
5 .. _dbus-python: http://www.freedesktop.org/wiki/Software/DBusBindings#python
7 Usage
8 =====
10 Online documentation can be found at
11 <http://dbus.freedesktop.org/doc/dbus-python/>.
13 There is an incomplete tutorial in `doc/tutorial.txt`__
14 (if you compile dbus-python with `docutils`_' ``rst2html`` tool installed or
15 you're reading this document on the D-Bus website, there's also an
16 `HTML version`__).
18 __ doc/tutorial.txt
19 __ doc/tutorial.html
21 `API documentation`_ is generated if you compile dbus-python with `epydoc`_
22 version 3 and `docutils`_ installed. An `online copy of the API documentation`_
23 is also available.
25 .. _API documentation: api/index.html
26 .. _epydoc: http://epydoc.sourceforge.net/
27 .. _docutils: http://docutils.sourceforge.net/
28 .. _online copy of the API documentation:
29    http://dbus.freedesktop.org/doc/dbus-python/api/
31 To develop on dbus-python, see `doc/HACKING.txt`__ or the `HTML version`__.
33 __ doc/HACKING.txt
34 __ doc/HACKING.html