Add settings to docs

docs/api.rst

@@ -30,7 +30,9 @@ subclassing but rather take the model class as a ``__init__`` parameter.
 .. autoclass:: cacheback.queryset.QuerySetGetJob
     :members:
 
-Example usage::
+Example usage:
+
+.. sourcecode:: python
 
     from django.contrib.auth import models
     from django.shortcuts import render

docs/contributing.rst

@@ -4,7 +4,7 @@ Contributing
 
 Get set up by cloning, creating a virtualenv and running::
 
-    make develop
+    $ make develop
 
 to install the testing dependencies.
 
@@ -13,33 +13,33 @@ Running tests
 
 Use::
 
-    ./runtests.py
+    $ ./runtests.py
 
 Sandbox VM
 ==========
 
 There is a VagrantFile for setting up a sandbox VM where you can play around
 with the functionality.  Bring up the Vagrant box::
 
-    vagrant up
+    $ vagrant up
 
-then provision:
+then provision::
 
-    cd /vagrant/sandbox
-    ./provision.sh
+    $ cd /vagrant/sandbox
+    $ ./provision.sh
 
 This may take a while but will set up a Ubuntu Precise64 VM with RabbitMQ
 installed and configured.  You can then SSH into the machine and run the Django
 development server::
 
-    vagrant ssh
-    cd /vagrant/sandbox
-    ./manage.py loaddata/fixture.json
-    ./manage.py runserver 0.0.0.0:8000
+    $ vagrant ssh
+    $ cd /vagrant/sandbox
+    $ ./manage.py loaddata/fixture.json
+    $ ./manage.py runserver 0.0.0.0:8000
 
 The dummy site will be available at ``localhost:8080``.  There are some sample
 views in ``sandbox/dummyapp/views.py`` that exercise django-cacheback.
 
 Run a Celery worker using::
 
-    ./manage.py celery worker --loglevel=INFO
+    $ ./manage.py celery worker --loglevel=INFO

docs/index.rst

@@ -76,7 +76,9 @@ shortcomings of this approach are:
 .. _`cache stampede`: http://en.wikipedia.org/wiki/Cache_stampede
 
 Now, consider an alternative implementation that uses a Celery task to repopulate the
-cache asynchronously instead of during the request/response cycle::
+cache asynchronously instead of during the request/response cycle:
+
+.. sourcecode:: python
 
     import datetime
     from django.shortcuts import render
@@ -187,6 +189,7 @@ Contents
    installation
    usage
    api
+   settings
    advanced
    contributing
 

docs/installation.rst

@@ -4,8 +4,8 @@ Installation
 
 You need to do four things:
 
-1. Install Cacheback
-~~~~~~~~~~~~~~~~~~~~
+1. Install django-cacheback
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Run::
 

docs/settings.rst

@@ -0,0 +1,16 @@
+========
+Settings
+========
+
+``CACHEBACK_CACHE_ALIAS``
+-------------------------
+
+This specifies which cache to use from your ``CACHES`` setting. It defaults to
+``default``.
+
+
+``CACHEBACK_VERIFY_CACHE_WRITE``
+--------------------------------
+
+This verifies the data is correctly written to memcache. If not, then a
+``RuntimeError`` is raised. Defaults to ``True``.