summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPatrick Totzke <patricktotzke@gmail.com>2012-03-11 15:06:01 +0000
committerPatrick Totzke <patricktotzke@gmail.com>2012-03-11 15:08:07 +0000
commit827345c319b6cb9dd831f3cf0b2bebbbaed0e630 (patch)
treee006b6c58f9be24d6a3c3994813f73144b812c44
parent78719ce520f3304a88938fd393ba22df5c460c34 (diff)
docs: for settings.utils and settings.errors
-rw-r--r--alot/settings/theme.py1
-rw-r--r--docs/source/api/settings.rst15
2 files changed, 16 insertions, 0 deletions
diff --git a/alot/settings/theme.py b/alot/settings/theme.py
index 301cc547..30f9f52f 100644
--- a/alot/settings/theme.py
+++ b/alot/settings/theme.py
@@ -13,6 +13,7 @@ class Theme(object):
"""
:param path: path to theme file
:type path: str
+ :raises: :class:`~alot.settings.errors.ConfigError`
"""
self._spec = os.path.join(DEFAULTSPATH, 'theme.spec')
self._config = read_config(path, self._spec)
diff --git a/docs/source/api/settings.rst b/docs/source/api/settings.rst
index 00a64f83..2cb7ea74 100644
--- a/docs/source/api/settings.rst
+++ b/docs/source/api/settings.rst
@@ -20,9 +20,24 @@ They are user defined callables that expect to be called with the following para
:ui: :class:`~alot.ui.UI` -- the initialized main component
:dbm: :class:`~alot.db.DBManager` -- :obj:`ui.dbman`
+Settings Manager
+----------------
.. autoclass:: SettingsManager
:members:
+
+Errors
+------
+
+.. automodule:: alot.settings.errors
+ :members:
+
+Utils
+-----
+
+.. automodule:: alot.settings.utils
+ :members:
+
Themes
------
.. autoclass:: alot.settings.theme.Theme