Changeset 3668

Timestamp:

18/11/08 18:37:38 (7 weeks ago)

Author:

dmeyer

Message:

Add template for kaa.notifier doc

Location:

trunk/base

Files:

• doc/conf.py (modified) (1 diff)
• doc/notifier/index.rst (modified) (1 diff)
• doc/notifier/io.rst (added)
• doc/notifier/signals.rst (added)
• doc/notifier/threads.rst (added)
• doc/notifier/timer.rst (added)
• src/notifier/gobject.py (modified) (1 diff)

trunk/base/doc/conf.py

@@ -17 +17 @@
 # is relative to the documentation root, use os.path.abspath to make it
 # absolute, like shown here.
-sys.path.append(os.path.abspath('../build/lib.linux-i686-2.5'))
+for _lib in os.listdir('../build'):
+    if _lib.startswith('lib.'):
+        sys.path.insert(0, os.path.abspath('../build/' + _lib))
 from kaa.version import VERSION
 

trunk/base/doc/notifier/index.rst

@@ -13 +13 @@
    async
    mainloop
+   signals
+   timer
+   threads
+   io
+
+The following features are missing in the documentation:
+
+ * Default kaa.signals
+
+ * kaa.Event and kaa.Eventhandler

trunk/base/src/notifier/gobject.py

@@ -82 +82 @@
         mainloop with the threaded decorator.
 
-        @param mainloop: the mainloop object to use a mainloop based on gobject
+        :param mainloop: the mainloop object to use a mainloop based on gobject
           like the gstreamer or clutter mainloop. The object provided here must
           have a start and a stop function.