apidoc: some introdution in index

7 files changed, 68 insertions, 5 deletions

diff --git a/docs/accounts.rst b/docs/accounts.rst
index 8bbb208a..4cc57caa 100644
--- a/docs/accounts.rst
+++ b/docs/accounts.rst
@@ -22,6 +22,6 @@ Accounts
    :members:
 
 :class:`alot.account.AddressBook`
------------------------------
+----------------------------------
 .. autoclass:: alot.account.AddressBook()
    :members:
diff --git a/docs/commands.rst b/docs/commands.rst
new file mode 100644
index 00000000..cdb3cdd6
--- /dev/null
+++ b/docs/commands.rst
@@ -0,0 +1,2 @@
+Commands
+=========
diff --git a/docs/database.rst b/docs/database.rst
new file mode 100644
index 00000000..f6404d7c
--- /dev/null
+++ b/docs/database.rst
@@ -0,0 +1,26 @@
+Email Database
+==============
+
+.. module:: alot.db
+
+:class:`DBManager`
+---------------------------
+.. autoclass:: DBManager
+   :members:
+
+:class:`Thread`
+---------------------------
+.. autoclass:: Thread
+   :members:
+
+.. module:: alot.message
+
+:class:`Message`
+---------------------------
+.. autoclass:: Message
+   :members:
+
+:class:`Attachment`
+---------------------------
+.. autoclass:: Attachment
+   :members:
diff --git a/docs/index.rst b/docs/index.rst
index a629874c..422de860 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,6 +1,23 @@
 `alot` API overview
 ====================
 
+The main component is :class:`alot.ui.UI`, which integrates all "manager" objects,
+provides methods for user input and notifications.
+It sets up an urwid `mainloop` and widget tree and maintains the list of active buffers.
+
+There are different "managers" responsible for core functionalities:
+
+* a :class:`~alot.db.DBManager` to access the email database
+* an :class:`~alot.account.AccountManager` to deal with user accounts
+* a :class:`~alot.settings.AlotConfigParser` (subclasses :class:`configparserConfigParser`) for user settings
+* a :class:`~alot.settings.HookManager` to load custom python code to be used as hooks
+
+All user actions, triggered either by keybindings or the prompt, are given as commandline strings
+that are translated into :class:`alot.commands.Command` objects.
+Different actions are defined as a subclasses of :class:`~alot.commands.Command`, which live
+in `alot/commands/MODE.py`, where MODE is the name of the mode (:class:`Buffer` type) they
+are used in.
+
 Contents:
 
 .. toctree::
@@ -8,10 +25,10 @@ Contents:
 
    database
    interface
-   interaction
    settings
    accounts
    utils
+   commands
    
 
 Indices and tables
diff --git a/docs/interaction.rst b/docs/interface.rst
index 57638435..ee9c0c45 100644
--- a/docs/interaction.rst
+++ b/docs/interface.rst
@@ -1,5 +1,5 @@
-User Interaction
-================================
+User Interface
+==================
 
 In order to keep the interface non-blocking, alot makes use of 
 twisted's deferred - a framework that makes it easy to deal with callbacks.
@@ -40,4 +40,13 @@ Many commands in alot make use of a construct called
     .. automethod:: buffer_focus
     .. automethod:: buffer_close
     .. automethod:: get_buffers_of_type
-    .. automethod:: get_deep_focus
+
+
+Buffers
+---------------------
+TODO: describe use of buffers, link to subclasses
+
+
+Widgets
+--------
+non-standart urwid widgets used throughout alot
diff --git a/docs/settings.rst b/docs/settings.rst
new file mode 100644
index 00000000..31d6c818
--- /dev/null
+++ b/docs/settings.rst
@@ -0,0 +1,2 @@
+Accessing User Settings
+=======================
diff --git a/docs/utils.rst b/docs/utils.rst
new file mode 100644
index 00000000..8cfae2b7
--- /dev/null
+++ b/docs/utils.rst
@@ -0,0 +1,7 @@
+Utils
+=====
+
+.. currentmodule:: alot.helper
+
+.. automodule:: alot.helper
+  :members: