Typo's fixes etc

django-oscar · Dec 28, 2015 · 4731aba · 4731aba
1 parent 10c8540
commit 4731aba
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 26 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -45,15 +45,15 @@ Or you could add ``django-oscar-api`` to your project dependencies.
         $ pip install pip install git+https://github.com/django-oscar/django-oscar-api.git
 
 
-Use out of the box:
--------------------
+Use out-of-the-box
+------------------
 
-You can use the oscarapi application in an oscar ecommerce site without any customization. You can customize the serialiser fields for the product serializers in ``settings.py``. See for more information :doc:`/usage/outofthebox`
+You can use the oscarapi application in an oscar ecommerce site without any customization. See for more information :doc:`/usage/outofthebox`
 
 
-Play around with the sandbox:
------------------------------
-You can also install Oscar Api from source and run the sandbox site to play around a bit. Make sure to create a virtualenv first.
+Play around with the sandbox
+----------------------------
+You can also install Oscar API from source and run the sandbox site to play around a bit. Make sure to create a virtualenv first.
 
 .. code-block:: bash
 
@@ -68,22 +68,6 @@ You can also install Oscar Api from source and run the sandbox site to play arou
 Now you can browse the API at http://localhost:8000/api
 
 
-Usage Example:
---------------
-Add python example to show how to use the oscar api.
-
-
-Mixed usage:
-------------
-
-Integrate existing oscar installation in your website. You can use the oscar api for showing products / filling baskets / showing orders in your site and
-use the checkout views from oscar. (see special middleware for this)
-
-
-Checkout customization:
-
-
-
 But I want to customise the standard serializers / views!
 ---------------------------------------------------------
 
@@ -95,6 +79,7 @@ Probably you want this, because you already extended or changed Oscar's function
    :maxdepth: 1
 
    usage/outofthebox
+   usage/communicate_with_the_api
    usage/middleware
    usage/settings
    usage/customizing_oscarapi

diff --git a/docs/source/usage/example_usage.rst → ...source/usage/communicate_with_the_api.rst b/docs/source/usage/example_usage.rst → ...source/usage/communicate_with_the_api.rst
diff --git a/docs/source/usage/customizing_oscarapi.rst b/docs/source/usage/customizing_oscarapi.rst
@@ -1,5 +1,6 @@
+============================
 Customizing Django Oscar API
-----------------------------
+============================
 
 By using the `django-rest-framework`_ life has become easy, at least for customizing the Oscar API. Django Oscar API exists of a collection of views and serializers which can be overriden by following the steps below.
 

diff --git a/docs/source/usage/outofthebox.rst b/docs/source/usage/outofthebox.rst
@@ -1,4 +1,5 @@
-Use Oscar API out of the box
+============================
+Use Oscar API out-of-the-box
 ============================
 
 To use the oscarapi application in an oscar ecommerce site without overriding or customizing the default views and serializers just follow these steps:
@@ -16,7 +17,10 @@ To use the oscarapi application in an oscar ecommerce site without overriding or
     )
 
 .. attention::
-    We really need to write something here about ``oscarapi.middleware.ApiBasketMiddleWare`` and other middlewares.
+    Link to the middleware classes and to the settings section
+
 
+Mixed usage
+-----------
 .. attention::
-    Add something about customizing the fields in ``settings.py``
+    Write something about mixed usage (Oscar API and plain Oscar Views) here and link to the middleware.
diff --git a/docs/source/usage/settings.rst b/docs/source/usage/settings.rst
@@ -1,3 +1,4 @@
+==================
 Oscar API Settings
 ==================