update publisher documentation

broqer/publisher.py

@@ -22,12 +22,14 @@ class Publisher():
     publisher/subscriber are referenced as observable/observer.
 
     As information receiver use following method to interact with Publisher
-    .subscribe(subscriber) to subscribe for events on this publisher
-    .unsubscribe(subscriber) to unsubscribe
-    .get() to get the current state (will raise ValueError if not stateful)
+
+    * ``.subscribe(subscriber)`` to subscribe for events on this publisher
+    * ``.unsubscribe(subscriber)`` to unsubscribe
+    * ``.get()`` to get the current state (will raise ValueError if not stateful)
 
     When implementing a Publisher use the following methods:
-    .notify(value) calls .emit(value) on all subscribers
+
+    * ``.notify(value)`` calls .emit(value) on all subscribers
 
     :ivar _subscriptions: holding a list of subscribers
     """

docs/conf.py

@@ -26,3 +26,15 @@
     (master_doc, 'python-broqer.tex', 'python-broqer Documentation',
      u'Günther Jena', 'manual'),
 ]
+
+from sphinx.ext import autodoc
+
+class SimpleDocumenter(autodoc.ClassDocumenter):
+    objtype = "classdoc"
+
+    #do not indent the content
+    content_indent = ""
+
+    #do not add a header to the docstring
+    def add_directive_header(self, sig):
+        pass

docs/publishers.rst

@@ -1,9 +1,12 @@
 Publishers
 ==========
 
+.. autoclassdoc:: broqer.Publisher
+
 Publisher
 ---------
 .. autoclass:: broqer.Publisher
+   :members: subscribe, unsubscribe, get, notify, subscriptions, wait_for
 
 StatefulPublisher
 -----------------