Consolidate "Reference" section of docs

This commit: - Adds a reference index page - Stubs a page for management commands - Converts all app page titles to code (as I like how it looks on the reference index page) Still lots of work needed here to fill out the management command and templatetags pages.
django-oscar · Jun 3, 2014 · 8602a1b · 8602a1b
1 parent 0838608
commit 8602a1b
Show file tree

Hide file tree

Showing 20 changed files with 115 additions and 57 deletions.
diff --git a/docs/source/ref/apps/address.rst b/docs/source/ref/apps/address.rst
@@ -1,6 +1,6 @@
-=======
-Address
-=======
+======================
+``oscar.apps.address``
+======================
 
 The address app provides core address models - it doesn't provide any views or
 other functionality.  Of the 5 abstract models, only 2 have a non-abstract
@@ -16,4 +16,4 @@ Abstract models
 
 Views
 -----
-None.
+None.
diff --git a/docs/source/ref/apps/analytics.rst b/docs/source/ref/apps/analytics.rst
@@ -1,6 +1,6 @@
-=========
-Analytics
-=========
+========================
+``oscar.apps.analytics``
+========================
 
 The ``oscar.analytics`` module provides a few simple models for gathering analytics data
 on products and users.  It listens for signals from other apps, and creates/updates simple

diff --git a/docs/source/ref/apps/basket.rst b/docs/source/ref/apps/basket.rst
@@ -1,6 +1,6 @@
-======
-Basket
-======
+=====================
+``oscar.apps.basket``
+=====================
 
 The basket app handles shopping baskets, which essentially are a collection of
 products that hopefully end up being ordered.

diff --git a/docs/source/ref/apps/catalogue.rst b/docs/source/ref/apps/catalogue.rst
@@ -1,6 +1,6 @@
-=========
-Catalogue
-=========
+========================
+``oscar.apps.catalogue``
+========================
 
 This is an essential Oscar app which exposes functionality to manage your
 product catalogue.
@@ -18,4 +18,4 @@ Abstract models
 Views
 -----
 .. automodule:: oscar.apps.catalogue.views
-    :members:
+    :members:
diff --git a/docs/source/ref/apps/checkout.rst b/docs/source/ref/apps/checkout.rst
@@ -1,6 +1,6 @@
-========
-Checkout
-========
+=======================
+``oscar.apps.checkout``
+=======================
 
 Flow
 ----

diff --git a/docs/source/ref/apps/customer.rst b/docs/source/ref/apps/customer.rst
@@ -1,6 +1,6 @@
-========
-Customer
-========
+=======================
+``oscar.apps.customer``
+=======================
 
 The customer app bundles communication with customers. This includes models
 to record product alerts and sent emails. It also contains the views that

diff --git a/docs/source/ref/apps/dashboard.rst b/docs/source/ref/apps/dashboard.rst
@@ -1,6 +1,6 @@
-=========
-Dashboard
-=========
+========================
+``oscar.apps.dashboard``
+========================
 
 The dashboard is the backend interface for managing the store. That includes the
 product catalogue, orders and stock, offers etc. It is intended as a

diff --git a/docs/source/ref/apps/index.rst b/docs/source/ref/apps/index.rst
@@ -1,6 +1,6 @@
-=========================
-Oscar Core Apps explained
-=========================
+====
+Apps
+====
 
 Oscar is split up in multiple, mostly independent apps.
 
@@ -22,4 +22,4 @@ Oscar is split up in multiple, mostly independent apps.
    search
    shipping
    voucher
-   wishlists
+   wishlists
diff --git a/docs/source/ref/apps/offer.rst b/docs/source/ref/apps/offer.rst
@@ -1,6 +1,6 @@
-======
-Offers
-======
+====================
+``oscar.apps.offer``
+====================
 
 Oscar ships with a powerful and flexible offers engine which is contained in the
 offers app.  It is based around the concept of 'conditional offers' - that is,

diff --git a/docs/source/ref/apps/order.rst b/docs/source/ref/apps/order.rst
@@ -1,6 +1,6 @@
-=====
-Order
-=====
+====================
+``oscar.apps.order``
+====================
 
 The order app handles processing of orders.
 

diff --git a/docs/source/ref/apps/partner.rst b/docs/source/ref/apps/partner.rst
@@ -1,6 +1,6 @@
-=======
-Partner
-=======
+======================
+``oscar.apps.partner``
+======================
 
 The partner app mostly provides three abstract models.
 :class:`oscar.apps.partner.abstract_models.AbstractPartner` and

diff --git a/docs/source/ref/apps/payment.rst b/docs/source/ref/apps/payment.rst
@@ -1,6 +1,6 @@
-=======
-Payment
-=======
+======================
+``oscar.apps.payment``
+======================
 
 The payment app contains models that capture how orders are paid for.  It does
 not have any views.

diff --git a/docs/source/ref/apps/promotions.rst b/docs/source/ref/apps/promotions.rst
@@ -1,6 +1,6 @@
-==========
-Promotions
-==========
+=========================
+``oscar.apps.promotions``
+=========================
 
 Promotions are small blocks of content that can link through to other parts of this site.
 Examples include:

diff --git a/docs/source/ref/apps/search.rst b/docs/source/ref/apps/search.rst
@@ -1,6 +1,6 @@
-======
-Search
-======
+=====================
+``oscar.apps.search``
+=====================
 
 Oscar provides a search view that extends Haystack's ``FacetedSearchView`` to
 provide better support for faceting.  

diff --git a/docs/source/ref/apps/shipping.rst b/docs/source/ref/apps/shipping.rst
@@ -1,6 +1,6 @@
-========
-Shipping
-========
+=======================
+``oscar.apps.shipping``
+=======================
 
 See :doc:`/howto/how_to_configure_shipping` for details on how shipping works
 in Oscar.

diff --git a/docs/source/ref/apps/voucher.rst b/docs/source/ref/apps/voucher.rst
@@ -1,6 +1,6 @@
-=======
-Voucher
-=======
+======================
+``oscar.apps.voucher``
+======================
 
 Oscar ships with broad support for vouchers, which are handled by this app.
 

diff --git a/docs/source/ref/apps/wishlists.rst b/docs/source/ref/apps/wishlists.rst
@@ -1,6 +1,6 @@
-=========
-Wishlists
-=========
+========================
+``oscar.apps.wishlists``
+========================
 
 The wishlists app allows signed-in users to create one or more wishlists.  A
 user can add a product to their wishlist from the product detail page and manage

diff --git a/docs/source/ref/index.rst b/docs/source/ref/index.rst
@@ -0,0 +1,13 @@
+=========
+Reference
+=========
+
+.. toctree::
+   :maxdepth: 3
+
+   apps/index
+   templatetags
+   management_commands
+   signals
+   settings
+   core
diff --git a/docs/source/ref/management_commands.rst b/docs/source/ref/management_commands.rst
@@ -0,0 +1,45 @@
+===================
+Management commands
+===================
+
+``oscar_fork_app <applabel> <folder>``
+--------------------------------------
+
+Creates a local version of one of Oscar's core apps so it can be customised.
+
+A new python package will be created in the specified folder with a
+``models.py`` module and a folder of migrations.
+
+``oscar_fork_statics <folder>``
+-------------------------------
+
+Copies Oscar's static files into the specified folder so they can be
+customised.
+
+``oscar_calculate_scores``
+--------------------------
+
+Calculates product scores and updates each 
+:class:`~oscar.apps.analytics.models.ProductRecord` instance.
+
+``oscar_cleanup_alerts``
+-------------------------------
+
+``oscar_find_duplicate_emails``
+-------------------------------
+
+``oscar_generate_email_content``
+--------------------------------
+
+``oscar_import_catalogue``
+--------------------------
+
+``oscar_import_catalogue_images``
+---------------------------------
+
+``oscar_send_alerts``
+---------------------
+
+``oscar_update_product_ratings``
+--------------------------------
+
diff --git a/docs/source/ref/settings.rst b/docs/source/ref/settings.rst
@@ -1,6 +1,6 @@
-==============
-Oscar settings
-==============
+========
+Settings
+========
 
 This is a comprehensive list of all the settings Oscar provides.  All settings
 are optional.