added configuration sections to documentation

docs/conf.py

@@ -12,10 +12,8 @@
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.
-
 import sys
 import os
-import wagtailsocialfeed
 import sphinx_rtd_theme
 
 # If extensions (or modules to document with autodoc) are in another
@@ -33,6 +31,7 @@
 # version is used.
 sys.path.insert(0, project_root)
 
+import wagtailsocialfeed
 
 # -- General configuration ---------------------------------------------
 

docs/configuration.rst

@@ -0,0 +1,45 @@
+=============
+Configuration
+=============
+
+The following configuration options are available:
+
+``WAGTAIL_SOCIALFEED_CONFIG``
+-----------------------------
+The configuration for the social media accounts. ::
+
+    WAGTAIL_SOCIALFEED_CONFIG = {
+        'twitter': {
+            'CONSUMER_KEY': 'SOME_KEY',
+            'CONSUMER_SECRET': 'SOME_SECRET',
+            'ACCESS_TOKEN_KEY': 'SOME_KEY',
+            'ACCESS_TOKEN_SECRET': 'SOME_SECRET'
+        },
+        'facebook': {
+            'CLIENT_ID': 'SOME_ID',
+            'CLIENT_SECRET': 'SOME_SECRET',
+        }
+    }
+
+No credentials are needed for Instagram.
+
+Defaults to ``{}``
+
+
+``WAGTAIL_SOCIALFEED_CACHE_DURATION``
+-------------------------------------
+
+The cache timeout (in seconds) for the social feed items
+
+Defaults to ``900``
+
+
+``WAGTAIL_SOCIALFEED_SEARCH_MAX_HISTORY``
+-----------------------------------------
+
+The amount of time the module is allowed to search through the history of the social feed.
+This is only used for the moderator view. In the moderator view it is possible to enter
+a search query. For the search to return a usable data-set, multiple result-pages are requested
+from the social feed source. But it does need to have a limit.
+
+Defaults to ``timedelta(weeks=26)``

docs/index.rst

@@ -14,6 +14,7 @@ Contents:
    readme
    installation
    usage
+   configuration
    contributing
 
 Indices and tables