Restore settings docs

docs/docs_settings.py

@@ -1,15 +1,12 @@
 """
-This is the local_settings file for Mezzanine's docs.
+This is the local_settings file for Cartridge's docs.
 """
 
-from mezzanine.project_template.project_name.settings import *
+from cartridge.project_template.project_name.settings import *
 
-ROOT_URLCONF = "mezzanine.project_template.project_name.urls"
+ROOT_URLCONF = "cartridge.project_template.project_name.urls"
 
 # Generate a SECRET_KEY for this build
 from random import choice
 characters = 'abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(-_=+)'
 SECRET_KEY = ''.join([choice(characters) for i in range(50)])
-
-if "mezzanine.accounts" not in INSTALLED_APPS:
-    INSTALLED_APPS = tuple(INSTALLED_APPS) + ("mezzanine.accounts",)

docs/settings.rst

@@ -1 +1,197 @@
-.. THIS DOCUMENT IS AUTO GENERATED VIA conf.py
+.. THIS DOCUMENT IS AUTO GENERATED VIA conf.py
+
+``SHOP_CARD_TYPES``
+-------------------
+
+Sequence of available credit card types for payment.
+
+Default: ``('Mastercard', 'Visa', 'Diners', 'Amex')``
+
+``SHOP_CART_EXPIRY_MINUTES``
+----------------------------
+
+Number of minutes of inactivity until carts are abandoned.
+
+Default: ``30``
+
+``SHOP_CATEGORY_USE_FEATURED_IMAGE``
+------------------------------------
+
+Enable featured images in shop categories
+
+Default: ``False``
+
+``SHOP_CHECKOUT_ACCOUNT_REQUIRED``
+----------------------------------
+
+If True, users must create a login for the checkout process.
+
+Default: ``False``
+
+``SHOP_CHECKOUT_STEPS_CONFIRMATION``
+------------------------------------
+
+If True, the checkout process has a final confirmation step before completion.
+
+Default: ``True``
+
+``SHOP_CHECKOUT_STEPS_SPLIT``
+-----------------------------
+
+If True, the checkout process is split into separate billing/shipping and payment steps.
+
+Default: ``True``
+
+``SHOP_CURRENCY_LOCALE``
+------------------------
+
+Controls the formatting of monetary values according to the locale module in the python standard library. If an empty string is used, will fall back to the system's locale.
+
+Default: ``''``
+
+``SHOP_DEFAULT_SHIPPING_VALUE``
+-------------------------------
+
+Default cost of shipping when no custom shipping is implemented.
+
+Default: ``10.0``
+
+``SHOP_DISCOUNT_FIELD_IN_CART``
+-------------------------------
+
+Discount codes can be entered on the cart page.
+
+Default: ``True``
+
+``SHOP_DISCOUNT_FIELD_IN_CHECKOUT``
+-----------------------------------
+
+Discount codes can be entered on the first checkout step.
+
+Default: ``True``
+
+``SHOP_HANDLER_BILLING_SHIPPING``
+---------------------------------
+
+Dotted package path and class name of the function called upon submission of the billing/shipping checkout step. This is where shipping calculations can be performed and set using the function ``cartridge.shop.utils.set_shipping``.
+
+Default: ``'cartridge.shop.checkout.default_billship_handler'``
+
+``SHOP_HANDLER_ORDER``
+----------------------
+
+Dotted package path and class name of the function that is called once an order is successful and all of the order object's data has been created. This is where any custom order processing should be implemented.
+
+Default: ``'cartridge.shop.checkout.default_order_handler'``
+
+``SHOP_HANDLER_PAYMENT``
+------------------------
+
+Dotted package path and class name of the function that is called upon submission of the payment checkout step. This is where integration with a payment gateway should be implemented.
+
+Default: ``'cartridge.shop.checkout.default_payment_handler'``
+
+``SHOP_HANDLER_TAX``
+--------------------
+
+Dotted package path and class name of the function called upon submission of the billing/shipping checkout step. This is where tax calculations can be performed and set using the function ``cartridge.shop.utils.set_tax``.
+
+Default: ``'cartridge.shop.checkout.default_tax_handler'``
+
+``SHOP_OPTION_ADMIN_ORDER``
+---------------------------
+
+Sequence of indexes from the ``SHOP_OPTION_TYPE_CHOICES`` setting that control how the options should be ordered in the admin, eg given the default for ``SHOP_OPTION_ADMIN_ORDER``, to order by Colour then Size we'd use (2, 1)
+
+Default: ``()``
+
+``SHOP_OPTION_TYPE_CHOICES``
+----------------------------
+
+Sequence of value/name pairs for types of product options (e.g. Size, Colour).
+
+Default: ``((1, 'Size'), (2, 'Colour'))``
+
+``SHOP_ORDER_EMAIL_BCC``
+------------------------
+
+All order receipts will be BCCd to this address.
+
+Default: ``''``
+
+``SHOP_ORDER_EMAIL_SUBJECT``
+----------------------------
+
+Subject to be used when sending the order receipt email.
+
+Default: ``'Order Receipt'``
+
+``SHOP_ORDER_FROM_EMAIL``
+-------------------------
+
+Email address from which order receipts should be emailed.
+
+Default: ``[dynamic]``
+
+``SHOP_ORDER_STATUS_CHOICES``
+-----------------------------
+
+Sequence of value/name pairs for order statuses.
+
+Default: ``((1, 'Unprocessed'), (2, 'Processed'))``
+
+``SHOP_PAYMENT_STEP_ENABLED``
+-----------------------------
+
+If False, there is no payment step on the checkout process.
+
+Default: ``True``
+
+``SHOP_PER_PAGE_CATEGORY``
+--------------------------
+
+Number of products to display per category page.
+
+Default: ``12``
+
+``SHOP_PRODUCT_SORT_OPTIONS``
+-----------------------------
+
+Sequence of description/field+direction pairs defining the options available for sorting a list of products.
+
+Default: ``(('Recently added', '-date_added'), ('Highest rated', '-rating_average'), ('Least expensive', 'unit_price'), ('Most expensive', '-unit_price'))``
+
+``SHOP_USE_RATINGS``
+--------------------
+
+Show the product rating form, and allow browsing by rating.
+
+Default: ``True``
+
+``SHOP_USE_RELATED_PRODUCTS``
+-----------------------------
+
+Show related products in templates, and allow editing them in the admin.
+
+Default: ``True``
+
+``SHOP_USE_UPSELL_PRODUCTS``
+----------------------------
+
+Show upsell products in templates, and allow editing them in the admin.
+
+Default: ``True``
+
+``SHOP_USE_VARIATIONS``
+-----------------------
+
+Use product variations.
+
+Default: ``True``
+
+``SHOP_USE_WISHLIST``
+---------------------
+
+Show the links to the wishlist, and allow adding products to it.
+
+Default: ``True``