diff options
| author | pazz <patricktotzke@gmail.com> | 2011-08-12 19:08:46 +0100 |
|---|---|---|
| committer | pazz <patricktotzke@gmail.com> | 2011-08-12 19:08:46 +0100 |
| commit | 4da59074598a3f25953107cc7fef0f75590a389c (patch) | |
| tree | c10d30831b8a240c9840f082f6fcc23d8e106b9e /docs | |
| parent | 6ab5f52cc0d8364de7c03d839067942d6f6a39c1 (diff) | |
api docu
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/accounts.rst | 23 | ||||
| -rw-r--r-- | docs/db.rst | 23 | ||||
| -rw-r--r-- | docs/interaction.rst | 17 |
3 files changed, 63 insertions, 0 deletions
diff --git a/docs/accounts.rst b/docs/accounts.rst new file mode 100644 index 00000000..8d205ddb --- /dev/null +++ b/docs/accounts.rst @@ -0,0 +1,23 @@ + +Getting Account information +====================================== + +.. currentmodule:: alot.account + +:class:`alot.account.AccountManager` +------------------------------------ + +.. autoclass:: alot.account.AccountManager + + .. automethod:: get_accounts + + .. automethod:: get_account_by_address + + .. automethod:: get_main_addresses + + .. automethod:: get_addresses + +:class:`alot.account.Account` +----------------------------- +.. autoclass:: alot.account.Account + :members: diff --git a/docs/db.rst b/docs/db.rst new file mode 100644 index 00000000..8a0a51ca --- /dev/null +++ b/docs/db.rst @@ -0,0 +1,23 @@ + +database abstraction +====================================== + +:class:`alot.db.DBManager` +--------------------------- +.. autoclass:: alot.db.DBManager + :members: + +:class:`alot.db.Thread` +--------------------------- +.. autoclass:: alot.db.Thread + :members: + +:class:`alot.message.Message` +--------------------------- +.. autoclass:: alot.message.Message + :members: + +:class:`alot.message.Attachment` +--------------------------- +.. autoclass:: alot.message.Attachment + :members: diff --git a/docs/interaction.rst b/docs/interaction.rst new file mode 100644 index 00000000..d14798ec --- /dev/null +++ b/docs/interaction.rst @@ -0,0 +1,17 @@ +User Interaction +================================ + +.. currentmodule:: alot.ui + +:class:`alot.ui.UI` +--------------------- + +.. autoclass:: UI + + .. automethod:: choice + + .. automethod:: notify + + .. automethod:: prompt + + .. automethod:: get_deep_focus |