Commits

Kostas Papadimitriou committed 18c0c14

custom settings documentation

Comments (0)

Files changed (1)

docs/source/settings.rst

    You can run some processes when datastore is accessed.
    If you are unfamiliar with DB hook, you should set this to ``False``.
    The default is ``False``.
+
+
+Designating the settings
+========================
+
+You can tell Kay which settings to use by using an environmental variable named 
+``KAY_SETTINGS_MODULE``. 
+
+The value of KAY_SETTINGS_MODULE  should be in Python path syntax, e.g. settings_package.dev_settings. 
+Note that the settings module should be on the Python `import search path`_.
+
+.. _import search path: http://diveintopython.org/getting_to_know_python/everything_is_an_object.html
+
+Example (Unix Bash shell)::
+
+    export KAY_SETTINGS_MODULE=settings_package.dev_settings
+    python manage.py runserver
+