From: Marek Marecki Date: Sun, 5 May 2013 21:51:08 +0000 (+0200) Subject: Documentation fixed. X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=00fc796357ca8aa12b9292897bde2e2d45c08b4a;p=diaspy.git Documentation fixed. --- diff --git a/diaspy/client.py b/diaspy/client.py index 2973087..071d968 100644 --- a/diaspy/client.py +++ b/diaspy/client.py @@ -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 index 0000000..a4d4609 --- /dev/null +++ b/docs/source/connection.rst @@ -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 index 0000000..8b705a6 --- /dev/null +++ b/docs/source/conversations.rst @@ -0,0 +1,7 @@ +conversations Module +==================== + +.. automodule:: diaspy.conversations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules.rst b/docs/source/modules.rst index 7a1b7a3..dcda9d0 100644 --- a/docs/source/modules.rst +++ b/docs/source/modules.rst @@ -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 index 0000000..874944f --- /dev/null +++ b/docs/source/streams.rst @@ -0,0 +1,7 @@ +streams Module +============== + +.. automodule:: diaspy.streams + :members: + :undoc-members: + :show-inheritance: