Browse Source

Update docs

sh4nks 11 years ago
parent
commit
98434b43c2
2 changed files with 50 additions and 8 deletions
  1. 2 1
      docs/events.rst
  2. 48 7
      docs/settings.rst

+ 2 - 1
docs/events.rst

@@ -9,7 +9,8 @@ events.
 .. admonition:: Additional events
 
     If you miss an event, feel free to open a new issue or create a pull
-    request.
+    request. The pull request should always contain a entry in this document
+    with a small example.
 
     A event can be created by placing a :func:`~flask.ext.plugins.emit_event`
     function at specific places in the code which then can modify the behavior

+ 48 - 7
docs/settings.rst

@@ -1,18 +1,59 @@
 .. _settings:
 
-Settings (WIP)
-==============
+Settings
+========
 
-extra fields:
-    min
-    max
-    choices with or without coerce
+This part covers which setting fields are available.
+This is especially useful if you plan on develop a plugin a want to contribute
+to FlaskBB.
+
+
+
+The available fields are shown below.
+
+.. note::
+    For a full list of available methods, visit
+    `Settings Model <models.html#flaskbb.management.models.Setting>`__.
+
+
+.. module:: flaskbb.management.models
+
+
+.. autoclass:: Setting
+
+    .. attribute:: key
+
+    **TODO**
 
+    .. attribute:: value
 
-value types:
+    **TODO**
+
+    .. attribute:: settingsgroup
+
+    **TODO**
+
+    .. attribute:: name
+
+    **TODO**
+
+    .. attribute:: description
+
+    **TODO**
+
+    .. attribute:: value_type
+
+    **TODO**
     string
     integer
     float
     boolean
     select          # 1 value
     selectmultiple  # multiple values
+
+    .. attribute:: extra
+
+    **TODO**
+    min
+    max
+    choices with or without coerce