summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon McVittie <simon.mcvittie@collabora.co.uk>2007-08-01 19:59:19 +0100
committerSimon McVittie <simon.mcvittie@collabora.co.uk>2007-08-01 19:59:19 +0100
commit44471aab0502cfccef6a4fb63f01feeb6bf8732e (patch)
tree3c89d70a1f3ab33134e5f001032263a96f272040
parentd3208ff19c3b61ae006403a9096c7a7ac09d4f5f (diff)
downloaddbus-python-44471aab0502cfccef6a4fb63f01feeb6bf8732e.tar.gz
Reorganise README to reflect that API docs are generated by default
-rw-r--r--README31
1 files changed, 11 insertions, 20 deletions
diff --git a/README b/README
index 611d2df..479d48f 100644
--- a/README
+++ b/README
@@ -11,33 +11,24 @@ Online documentation can be found at
<http://dbus.freedesktop.org/doc/dbus-python/>.
There is an incomplete tutorial in `doc/tutorial.txt`__
-(if you compile dbus-python with ``rst2html`` installed or you're reading
-this document on the D-Bus website, there's also an `HTML version`__).
+(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
-For client code, see the docstring for dbus/__init__.py.
+`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.
-To export objects, see the docstring for dbus/service.py.
+.. _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
-
-Building the API documentation
-==============================
-
-Because the API documentation is generated with a pre-release version of
-epydoc, it's not currently built by default. To do so, install
-`epydoc`_ 3 alpha and `docutils`_, and run ``./configure`` with the
-``--enable-api-docs`` option. Documentation starts from ``api/index.html``.
-
-.. _epydoc: http://epydoc.sourceforge.net/
-.. _docutils: http://docutils.sourceforge.net/
-
-A copy of the documentation can be found here:
-`dbus-python API documentation on people.freedesktop.org`__
-
-__ http://dbus.freedesktop.org/doc/dbus-python/api/