summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPatrick Totzke <patricktotzke@gmail.com>2012-08-05 14:40:19 +0100
committerPatrick Totzke <patricktotzke@gmail.com>2012-08-10 13:03:40 +0100
commitfd18448d298d2a741303083cdecd7bb21883a0f4 (patch)
treea00894841aa7d95d2b5dbc4424e90f13bc5b25cc /docs
parent7dc706404c51d828085b9d975a44c993a9f80129 (diff)
doc: update api docs wrt moved parts
Diffstat (limited to 'docs')
-rw-r--r--docs/source/api/database.rst18
-rw-r--r--docs/source/api/interface.rst24
-rw-r--r--docs/source/api/settings.rst39
3 files changed, 54 insertions, 27 deletions
diff --git a/docs/source/api/database.rst b/docs/source/api/database.rst
index 71fa50ef..ff66fd3e 100644
--- a/docs/source/api/database.rst
+++ b/docs/source/api/database.rst
@@ -5,23 +5,23 @@ Email Database
The python bindings to libnotmuch define :class:`notmuch.Thread` and
:class:`notmuch.Message`, which unfortunately are very fragile.
-Alot defines the wrapper classes :class:`Thread` and :class:`~alot.db.message.Message` that
-use an :class:`DBManager` instance to transparently provide persistent objects.
+Alot defines the wrapper classes :class:`alot.db.Thread` and :class:`alot.db.Message` that
+use an :class:`manager.DBManager` instance to transparently provide persistent objects.
-:class:`~alot.db.message.Message` moreover contains convenience methods
+:class:`alot.db.Message` moreover contains convenience methods
to extract information about the message like reformated header values, a summary,
decoded and interpreted body text and a list of :class:`Attachments <alot.db.attachment.Attachment>`.
-The central :class:`~alot.ui.UI` instance carries around a :class:`DBManager` object that
-is used for any lookups or modifications of the email base. :class:`DBManager` can
-directly look up :class:`Thread` and :class:`~alot.db.message.Message` objects and is able to
+The central :class:`~alot.ui.UI` instance carries around a :class:`~manager.DBManager` object that
+is used for any lookups or modifications of the email base. :class:`~manager.DBManager` can
+directly look up :class:`Thread` and :class:`~alot.db.Message` objects and is able to
postpone/cache/retry writing operations in case the Xapian index is locked by another
process.
Database Manager
-----------------
-.. autoclass:: DBManager
+.. autoclass:: alot.db.manager.DBManager
:members:
@@ -41,11 +41,11 @@ Errors
Wrapper
-------
-.. autoclass:: alot.db.thread.Thread
+.. autoclass:: alot.db.Thread
:members:
-.. autoclass:: alot.db.message.Message
+.. autoclass:: alot.db.Message
:members:
diff --git a/docs/source/api/interface.rst b/docs/source/api/interface.rst
index f9afb7ec..d2294e26 100644
--- a/docs/source/api/interface.rst
+++ b/docs/source/api/interface.rst
@@ -85,7 +85,29 @@ Widgets
What follows is a list of the non-standard urwid widgets used in alot.
Some of them respect :doc:`user settings <settings>`, themes in particular.
-.. automodule:: alot.widgets
+utils
+`````
+.. automodule:: alot.widgets.utils
+ :members:
+
+globals
+```````
+.. automodule:: alot.widgets.globals
+ :members:
+
+bufferlist
+``````````
+.. automodule:: alot.widgets.bufferlist
+ :members:
+
+search
+``````
+.. automodule:: alot.widgets.search
+ :members:
+
+thread
+``````
+.. automodule:: alot.widgets.thread
:members:
Completion
diff --git a/docs/source/api/settings.rst b/docs/source/api/settings.rst
index 2cb7ea74..4f8dc455 100644
--- a/docs/source/api/settings.rst
+++ b/docs/source/api/settings.rst
@@ -1,24 +1,29 @@
User Settings
=============
-.. module:: alot.settings
+.. module:: alot.settings.manager
+
+Alot sets up a :class:`SettingsManager` to access user settings
+defined in different places uniformly.
+There are four types of user settings:
+
++------------------------------------+----------------------------------+---------------------------------------------+
+| what? | location | accessible via |
++====================================+==================================+=============================================+
+| alot config | :file:`~/.config/alot/config` | :meth:`SettingsManager.get` |
+| | or given by command option `-c`. | |
++------------------------------------+----------------------------------+---------------------------------------------+
+| hooks -- user provided python code | :file:`~/.config/alot/hooks.py` | :meth:`SettingsManager.get_hook` |
+| | or as given by the `hooksfile` | |
+| | config value | |
++------------------------------------+----------------------------------+---------------------------------------------+
+| notmuch config | :file:`~/.notmuchrc` | :meth:`SettingsManager.get_notmuch_setting` |
+| | or given by command option `-n` | |
++------------------------------------+----------------------------------+---------------------------------------------+
+| mailcap -- defines shellcommands | :file:`~/.mailcap` | :meth:`SettingsManager.mailcap_find_match` |
+| to handle mime types | (:file:`/etc/mailcap`) | |
++------------------------------------+----------------------------------+---------------------------------------------+
-There are four types of user settings: notmuchs and alot's config
-files, the hooks-file for user provided python code and the mailcap,
-defining shell comands as handlers for files of certain mime types.
-Alot sets up :class:`SettingsManager` objects to access these user settings uniformly.
-
-MIME handlers can be looked up via :meth:`SettingsManager.get_mime_handler`,
-config values of alot and notmuch's config are accessible using
-:meth:`SettingsManager.get` and :meth:`SettingsManager.get_notmuch_setting`.
-These methods return either None or the requested value typed as indicated in
-the spec files :file:`alot/defaults/*spec`.
-
-Hooks can be looked up via :meth:`SettingsManager.get_hook`.
-They are user defined callables that expect to be called with the following parameters:
-
- :ui: :class:`~alot.ui.UI` -- the initialized main component
- :dbm: :class:`~alot.db.DBManager` -- :obj:`ui.dbman`
Settings Manager
----------------