diff options
| author | Patrick Totzke <patricktotzke@gmail.com> | 2011-11-28 13:04:24 +0000 |
|---|---|---|
| committer | Patrick Totzke <patricktotzke@gmail.com> | 2011-11-28 13:04:24 +0000 |
| commit | 6607e8656f4e3d445458784601597912f5c0f7eb (patch) | |
| tree | e5a0c7f6e512c101032e6d3b0f61587382e0c623 /docs | |
| parent | 9a084cb53e14bf07b48100417c671ccc9b7ac52c (diff) | |
added commands to apidoc
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/commands.rst | 39 | ||||
| -rw-r--r-- | docs/index.rst | 8 |
2 files changed, 42 insertions, 5 deletions
diff --git a/docs/commands.rst b/docs/commands.rst index cdb3cdd6..a59ceaf5 100644 --- a/docs/commands.rst +++ b/docs/commands.rst @@ -1,2 +1,41 @@ Commands ========= + +.. module:: alot.commands +.. autoclass:: Command + +Globals +-------- + +.. automodule:: alot.commands.globals + :members: + +Envelope +-------- + +.. automodule:: alot.commands.envelope + :members: + +Bufferlist +---------- + +.. automodule:: alot.commands.bufferlist + :members: + +Search +-------- + +.. automodule:: alot.commands.search + :members: + +Taglist +-------- + +.. automodule:: alot.commands.taglist + :members: + +Thread +-------- + +.. automodule:: alot.commands.thread + :members: diff --git a/docs/index.rst b/docs/index.rst index 422de860..4802ad26 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,11 +1,9 @@ `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: +The main component is :class:`alot.ui.UI`, which provides methods for user input and notifications, +sets up an urwid `mainloop` and widget tree and maintains the list of active buffers. +Moreover, it integrates 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 |