From 6c630a819f6504d48a3a205ab323b2d0458913e5 Mon Sep 17 00:00:00 2001 From: Simon McVittie Date: Wed, 2 May 2018 11:08:09 +0100 Subject: Convert documentation from epydoc to Sphinx Signed-off-by: Simon McVittie --- README | 27 ++------------------------- 1 file changed, 2 insertions(+), 25 deletions(-) (limited to 'README') diff --git a/README b/README index 7c1c49d..f46dbad 100644 --- a/README +++ b/README @@ -4,35 +4,12 @@ dbus-python_: Python bindings for D-Bus .. _dbus-python: http://www.freedesktop.org/wiki/Software/DBusBindings#python -Usage -===== +dbus-python is the original Python binding for ``dbus``, the reference +implementation of the D-Bus protocol. Online documentation can be found at . -There is an incomplete tutorial in `doc/tutorial.txt`__ -(if you compile dbus-python with `docutils`_' ``rst2html`` tool installed or -you're reading this document on the D-Bus website, there's also an -`HTML version`__). - -__ doc/tutorial.txt -__ doc/tutorial.html - -`API documentation`_ is generated if you compile dbus-python with `epydoc`_ -version 3 and `docutils`_ installed. An `online copy of the API documentation`_ -is also available. - -.. _API documentation: api/index.html -.. _epydoc: http://epydoc.sourceforge.net/ -.. _docutils: http://docutils.sourceforge.net/ -.. _online copy of the API documentation: - http://dbus.freedesktop.org/doc/dbus-python/api/ - -To develop on dbus-python, see `doc/HACKING.txt`__ or the `HTML version`__. - -__ doc/HACKING.txt -__ doc/HACKING.html - Problems and alternatives ========================= -- cgit v1.2.1