Documentation fixed.
authorMarek Marecki <triviuss@gmail.com>
Sun, 5 May 2013 21:51:08 +0000 (23:51 +0200)
committerMarek Marecki <triviuss@gmail.com>
Sun, 5 May 2013 21:51:08 +0000 (23:51 +0200)
diaspy/client.py
docs/source/connection.rst [new file with mode: 0644]
docs/source/conversations.rst [new file with mode: 0644]
docs/source/modules.rst
docs/source/streams.rst [new file with mode: 0644]

index 29730878a44a8c92b462309ac0bc47dc9bec0efc..071d9688d17237102f1f6614a885fd67d3fb5f34 100644 (file)
@@ -4,7 +4,8 @@ import diaspy.connection
 
 
 class Client:
-    """This is the client class to connect to Diaspora.
+    """This is the client class used to interact with Diaspora.
+    It can be used as a reference implementation of client using diaspy.
     """
     def __init__(self, pod, username='', password=''):
         """
diff --git a/docs/source/connection.rst b/docs/source/connection.rst
new file mode 100644 (file)
index 0000000..a4d4609
--- /dev/null
@@ -0,0 +1,7 @@
+connection Module
+=================
+
+.. automodule:: diaspy.connection
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/conversations.rst b/docs/source/conversations.rst
new file mode 100644 (file)
index 0000000..8b705a6
--- /dev/null
@@ -0,0 +1,7 @@
+conversations Module
+====================
+
+.. automodule:: diaspy.conversations
+    :members:
+    :undoc-members:
+    :show-inheritance:
index 7a1b7a388baea548a473936add6fed9b9212b543..dcda9d0cc14fe34b33ab8dbdd6f0434f76f0a219 100644 (file)
@@ -6,3 +6,6 @@ diaspy
 
    client
    models
+   streams
+   connection
+   conversations
diff --git a/docs/source/streams.rst b/docs/source/streams.rst
new file mode 100644 (file)
index 0000000..874944f
--- /dev/null
@@ -0,0 +1,7 @@
+streams Module
+==============
+
+.. automodule:: diaspy.streams
+    :members:
+    :undoc-members:
+    :show-inheritance: