diff options
author | Patrick Totzke <patricktotzke@gmail.com> | 2012-02-20 22:35:16 +0000 |
---|---|---|
committer | Patrick Totzke <patricktotzke@gmail.com> | 2012-02-20 22:35:16 +0000 |
commit | a53c722d9c1aaf647cd301d22ecf381b0ffe46fd (patch) | |
tree | 06aa06d9b340a64b382c6ac2f1b6d9b6303f521b /docs/source | |
parent | 4c533bcbc2b2a0be16e6bb837eb0a43ec180c4b0 (diff) |
update api docs: settings
Diffstat (limited to 'docs/source')
-rw-r--r-- | docs/source/api/accounts.rst | 5 | ||||
-rw-r--r-- | docs/source/api/index.rst | 1 | ||||
-rw-r--r-- | docs/source/api/interface.rst | 1 | ||||
-rw-r--r-- | docs/source/api/settings.rst | 25 | ||||
-rw-r--r-- | docs/source/configuration.rst | 6 |
5 files changed, 22 insertions, 16 deletions
diff --git a/docs/source/api/accounts.rst b/docs/source/api/accounts.rst deleted file mode 100644 index c09b43fa..00000000 --- a/docs/source/api/accounts.rst +++ /dev/null @@ -1,5 +0,0 @@ -Accounts -======== - -.. automodule:: alot.account - :members: diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst index 35b4fd7c..69be4f8a 100644 --- a/docs/source/api/index.rst +++ b/docs/source/api/index.rst @@ -10,6 +10,5 @@ API and Development database interface settings - accounts utils commands diff --git a/docs/source/api/interface.rst b/docs/source/api/interface.rst index 0df9d7ca..4c578e10 100644 --- a/docs/source/api/interface.rst +++ b/docs/source/api/interface.rst @@ -42,7 +42,6 @@ input and acts on it: .. autoattribute:: buffers .. autoattribute:: current_buffer .. autoattribute:: dbman - .. autoattribute:: accountman .. automethod:: apply_command .. automethod:: prompt diff --git a/docs/source/api/settings.rst b/docs/source/api/settings.rst index 3fea36f5..69f91097 100644 --- a/docs/source/api/settings.rst +++ b/docs/source/api/settings.rst @@ -1,12 +1,11 @@ -Accessing User Settings -======================= +User Settings +============= .. module:: alot.settings 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 shellcomands 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.settings.get_mime_handler`, @@ -15,7 +14,6 @@ config values of alot and notmuch's config are accessible using 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: @@ -24,3 +22,22 @@ They are user defined callables that expect to be called with the following para .. autoclass:: SettingsManager :members: + +Accounts +-------- + +.. module:: alot.account +.. autoclass:: Account + :members: +.. autoclass:: SendmailAccount + :members: + +Addressbooks +------------ + +.. autoclass:: AddressBook + :members: +.. autoclass:: MatchSdtoutAddressbook + :members: +.. autoclass:: AbookAddressBook + :members: diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst index 1c1d3eec..4afc333b 100644 --- a/docs/source/configuration.rst +++ b/docs/source/configuration.rst @@ -2,11 +2,7 @@ Configuration ************* - -All configs are optional, but if you want to send mails you need to -specify at least one account section. - -Alot reads a config file in the "INI" syntax: +Alot reads a config file in (extended) "INI" syntax: It consists of some sections whose names are given in square brackets, followed by key-value pairs that use "=" or ":" as separator, ';' and '#' are comment-prefixes. |