Include hooks and settings in toc

flaskbb · Oct 31, 2017 · 93b71ee · 93b71ee
1 parent 2649715
commit 93b71ee
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/docs/contents.rst.inc b/docs/contents.rst.inc
@@ -8,7 +8,8 @@ Contents
    cli
    theming
    plugins
-   events
+   hooks
+   settings
    api
 
 

diff --git a/docs/settings.rst b/docs/settings.rst
@@ -16,10 +16,25 @@ The available fields are shown below.
     `Settings Model <models.html#flaskbb.management.models.Setting>`__.
 
 
-.. module:: flaskbb.management.models
+.. autoclass:: flaskbb.utils.forms.SettingValueType
+    :members:
+    :undoc-members:
 
 
-.. autoclass:: Setting
+    ======================================== =========================================== =====================================
+    Value Type                               Rendered As                                 Parsed & Saved as
+    ======================================== =========================================== =====================================
+    :attr:`~SettingValueType.string`         :class:`wtforms.fields.StringField`         :class:`str`
+    :attr:`~SettingValueType.integer`        :class:`wtforms.fields.IntegerField`        :class:`int`
+    :attr:`~SettingValueType.float`          :class:`wtforms.fields.FloatField`          :class:`float`
+    :attr:`~SettingValueType.boolean`        :class:`wtforms.fields.BooleanField`        :class:`bool`
+    :attr:`~SettingValueType.select`         :class:`wtforms.fields.SelectField`         :class:`list`
+    :attr:`~SettingValueType.selectmultiple` :class:`wtforms.fields.SelectMultipleField` :class:`list`
+    ======================================== =========================================== =====================================
+
+    TODO
+
+.. autoclass:: flaskbb.management.models
     :noindex:
 
     .. attribute:: key