Kostas Papadimitriou avatar 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
+ 	
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.