work on doc

semiversus · Sep 27, 2018 · cdd0fd9 · cdd0fd9
1 parent 4dd9e27
commit cdd0fd9
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 9 deletions.
diff --git a/broqer/op/map_async.py b/broqer/op/map_async.py
@@ -116,8 +116,8 @@ class MapAsync(Operator):
     :param \\*args: variable arguments to be used for calling coro
     :param mode: behavior when a value is currently processed
     :param error_callback: error callback to be registered
-    :param unpack: value from emits will be unpacked as (*value)
-    :param \\*kwargs: keyword arguments to be used for calling coro
+    :param unpack: value from emits will be unpacked as (\\*value)
+    :param \\*\\*kwargs: keyword arguments to be used for calling coro
 
     :ivar scheduled: Publisher emitting the value when coroutine is actually
         started.

diff --git a/broqer/op/map_threaded.py b/broqer/op/map_threaded.py
@@ -102,8 +102,8 @@ class MapThreaded(MapAsync):
     :param \\*args: variable arguments to be used for calling function
     :param mode: behavior when a value is currently processed
     :param error_callback: error callback to be registered
-    :param unpack: value from emits will be unpacked as (*value)
-    :param \\**kwargs: keyword arguments to be used for calling function
+    :param unpack: value from emits will be unpacked as (\\*value)
+    :param \\*\\*kwargs: keyword arguments to be used for calling function
     """
     def __init__(self, function: Callable[[Any], Any], *args,
                  mode: MODE = MODE.CONCURRENT,  # type: ignore

diff --git a/broqer/publisher.py b/broqer/publisher.py
@@ -25,7 +25,8 @@ class 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)
+    * ``.get()`` to get the current state (will raise ValueError if not
+        stateful)
 
     When implementing a Publisher use the following methods:
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -29,12 +29,15 @@
 
 from sphinx.ext import autodoc
 
-class SimpleDocumenter(autodoc.ClassDocumenter):
+class ClassDocDocumenter(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
+        pass
+
+def setup(app):
+    app.add_autodocumenter(ClassDocDocumenter)
diff --git a/docs/operators/filter.rst b/docs/operators/filter.rst
@@ -9,4 +9,4 @@ Definition
 Usage
 -----
 
-.. automodule:: broqer.op.filter
+.. automodule:: broqer.op.filter_
diff --git a/docs/operators/map.rst b/docs/operators/map.rst
@@ -9,4 +9,4 @@ Definition
 Usage
 -----
 
-.. automodule:: broqer.op.map
+.. automodule:: broqer.op.map_