Bläddra i källkod

adding documentation on oscar settings and changing BASKET_COOKIE_LIFETIME to OSCAR_BASKET_COOKIE_LIFETIME for consistency

master
Jonathan Moss 14 år sedan
förälder
incheckning
cbd8532b86
3 ändrade filer med 42 tillägg och 0 borttagningar
  1. 1
    0
      docs/source/index.rst
  2. 10
    0
      docs/source/reference.rst
  3. 31
    0
      docs/source/reference/settings.rst

+ 1
- 0
docs/source/index.rst Visa fil

@@ -28,6 +28,7 @@ Contents:
28 28
    web_services
29 29
    recipes
30 30
    contributing
31
+   reference
31 32
 
32 33
 Indices and tables
33 34
 ==================

+ 10
- 0
docs/source/reference.rst Visa fil

@@ -0,0 +1,10 @@
1
+=========
2
+Reference
3
+=========
4
+
5
+Contents:
6
+
7
+.. toctree::
8
+   :maxdepth: 2
9
+
10
+   reference/settings

+ 31
- 0
docs/source/reference/settings.rst Visa fil

@@ -0,0 +1,31 @@
1
+=======================
2
+Oscar specific settings
3
+=======================
4
+
5
+Oscar provides a number of configurable settings used to confugre the system.
6
+
7
+.. contents::
8
+    :local:
9
+    :depth: 1
10
+
11
+Available settings
12
+==================
13
+
14
+OSCAR_DEFAULT_CURRENCY
15
+----------------------
16
+
17
+Default: None (This is a required field)
18
+
19
+This should be the symbol of the currency you wish Oscar to use by default.
20
+
21
+OSCAR_BASKET_COOKIE_LIFETIME
22
+----------------------------
23
+
24
+Default: 604800 (1 week in seconds)
25
+
26
+The time to live for the basket cookie.
27
+
28
+Deprecated Settings
29
+===================
30
+
31
+There are currently no deprecated settings in oscar

Laddar…
Avbryt
Spara