From c872b2d701e0bffcbbdba522c92fdc3f1458cf9f Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Mon, 1 Oct 2012 16:27:59 +0100 Subject: [PATCH] Latest docs build --- api-guide/authentication.html | 13 +- api-guide/content-negotiation.html | 5 +- api-guide/exceptions.html | 5 +- api-guide/format-suffixes.html | 5 +- api-guide/generic-views.html | 5 +- api-guide/p.html | 207 ++++++++++++++++ api-guide/pagination.html | 226 ++++++++++++++++++ api-guide/parsers.html | 5 +- api-guide/permissions.html | 5 +- api-guide/renderers.html | 5 +- api-guide/requests.html | 5 +- api-guide/responses.html | 32 ++- api-guide/reverse.html | 5 +- api-guide/serializers.html | 5 +- api-guide/settings.html | 5 +- api-guide/status-codes.html | 5 +- api-guide/throttling.html | 5 +- api-guide/views.html | 5 +- css/default.css | 4 +- index.html | 6 +- topics/browsable-api.html | 5 +- topics/changelog.html | 5 +- topics/contributing.html | 5 +- topics/credits.html | 8 +- topics/csrf.html | 5 +- topics/formoverloading.html | 5 +- topics/rest-hypermedia-hateoas.html | 5 +- tutorial/1-serialization.html | 5 +- tutorial/2-requests-and-responses.html | 5 +- tutorial/3-class-based-views.html | 5 +- ...entication-permissions-and-throttling.html | 5 +- .../5-relationships-and-hyperlinked-apis.html | 5 +- tutorial/6-resource-orientated-projects.html | 5 +- 33 files changed, 550 insertions(+), 76 deletions(-) create mode 100644 api-guide/p.html create mode 100644 api-guide/pagination.html diff --git a/api-guide/authentication.html b/api-guide/authentication.html index 23fb3bc55..109c5e541 100644 --- a/api-guide/authentication.html +++ b/api-guide/authentication.html @@ -16,7 +16,7 @@ - +
@@ -55,6 +55,7 @@
  • Authentication
  • Permissions
  • Throttling
    • +
  • Pagination
  • Content negotiation
  • Format suffixes
  • Returning URLs
    • @@ -134,6 +135,7 @@

    You can also set the authentication policy on a per-view basis, using the APIView class based views.

    class ExampleView(APIView):
     authentication_classes = (SessionAuthentication, UserBasicAuthentication)
+    permission_classes = (IsAuthenticated,)
 
     def get(self, request, format=None):
         content = {
@@ -143,10 +145,9 @@
         return Response(content)

    Or, if you're using the @api_view decorator with function based views.

    -
    @api_view(
-    allowed=('GET',),
-    authentication_classes=(SessionAuthentication, UserBasicAuthentication)
-)
+
    @api_view('GET'),
+@authentication_classes(SessionAuthentication, UserBasicAuthentication)
+@permissions_classes(IsAuthenticated)
 def example_view(request, format=None):
     content = {
         'user': unicode(request.user),  # `django.contrib.auth.User` instance.
@@ -218,4 +219,4 @@ print token.key
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/api-guide/content-negotiation.html b/api-guide/content-negotiation.html
index 668cbce45..2bf75bb05 100644
--- a/api-guide/content-negotiation.html
+++ b/api-guide/content-negotiation.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -128,4 +129,4 @@
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/api-guide/exceptions.html b/api-guide/exceptions.html
index de17aef0a..826e7b5a7 100644
--- a/api-guide/exceptions.html
+++ b/api-guide/exceptions.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -180,4 +181,4 @@ Content-Length: 42
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/api-guide/format-suffixes.html b/api-guide/format-suffixes.html
index a43aae2fb..4c50e2983 100644
--- a/api-guide/format-suffixes.html
+++ b/api-guide/format-suffixes.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -129,4 +130,4 @@ used all the time.
    
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/api-guide/generic-views.html b/api-guide/generic-views.html
index 8537062b5..33927ff0d 100644
--- a/api-guide/generic-views.html
+++ b/api-guide/generic-views.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -129,4 +130,4 @@
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/api-guide/p.html b/api-guide/p.html
new file mode 100644
index 000000000..45b692918
--- /dev/null
+++ b/api-guide/p.html
@@ -0,0 +1,207 @@
+
+
+    
+    Django REST framework
+    
+    
+    
+
+    
+    
+    
+    
+    
+
+    
+    
+  
+
+    
    
+      
    
+        
    
+            GitHub
+          
+            
+            
+            
+          
+          Django REST framework
+          
    
+            
+            
+          
    
+        
    
+      
    
+    
    
+
+    
    
+      
    
+        
    
+          
+        
    
+
+        
    
+          
    pagination.py
    
+
    Pagination
    
+
    
+
    Django provides a few classes that help you manage paginated data – that is, data that’s split across several pages, with “Previous/Next” links.
    
+
    — Django documentation
    
+
    
+
    REST framework includes a PaginationSerializer class that makes it easy to return paginated data in a way that can then be rendered to arbitrary media types. 
    
+
    Examples
    
+
    Let's start by taking a look at an example from the Django documentation.
    
+
    from django.core.paginator import Paginator
+objects = ['john', 'paul', 'george', 'ringo']
+paginator = Paginator(objects, 2)
+page = paginator.page(1)
+page.object_list
+# ['john', 'paul']
+
    
+
    At this point we've got a page object.  If we wanted to return this page object as a JSON response, we'd need to provide the client with context such as next and previous links, so that it would be able to page through the remaining results.
    
+
    from rest_framework.pagination import PaginationSerializer
+serializer = PaginationSerializer(instance=page)
+serializer.data
+# {'count': 4, 'next': '?page=2', 'previous': None, 'results': [u'john', u'paul']}
+
    
+
    The context argument of the PaginationSerializer class may optionally include the request.  If the request is included in the context then the next and previous links returned by the serializer will use absolute URLs instead of relative URLs.
    
+
    request = RequestFactory().get('/foobar')
+serializer = PaginationSerializer(instance=page, context={'request': request})
+serializer.data
+# {'count': 4, 'next': 'http://testserver/foobar?page=2', 'previous': None, 'results': [u'john', u'paul']}
+
    
+
    We could now return that data in a Response object, and it would be rendered into the correct media type.
    
+
    Our first example worked because we were using primative objects.  If we wanted to paginate a queryset or other complex data, we'd need to specify a serializer to use to serialize the result set itself with.
    
+
    We can do this using the object_serializer_class attribute on the inner Meta class of the pagination serializer.  For example.
    
+
    class UserSerializer(serializers.ModelSerializer):
+    """
+    Serializes user querysets.
+    """
+    class Meta:
+        model = User
+        fields = ('username', 'email')
+
+class PaginatedUserSerializer(pagination.PaginationSerializer):
+    """
+    Serializes page objects of user querysets.
+    """
+    class Meta:
+        object_serializer_class = UserSerializer
+
+queryset = User.objects.all()
+paginator = Paginator(queryset, 20)
+page = paginator.page(1)
+serializer = PaginatedUserSerializer(instance=page)
+serializer.data
+# {'count': 1, 'next': None, 'previous': None, 'results': [{'username': u'admin', 'email': u'admin@example.com'}]}
+
    
+
    Pagination in the generic views
    
+
    The generic class based views ListAPIView and ListCreateAPIView provide pagination of the returned querysets by default.  You can customise this behaviour by altering the pagination style, by modifying the default number of results, or by turning pagination off completely.
    
+
    Setting the default pagination style
    
+
    The default pagination style may be set globally, using the PAGINATION_SERIALIZER and PAGINATE_BY settings.  For example.
    
+
    REST_FRAMEWORK = {
+    'PAGINATION_SERIALIZER': (
+        'example_app.pagination.CustomPaginationSerializer',
+    ),
+    'PAGINATE_BY': 10
+}
+
    
+
    You can also set the pagination style on a per-view basis, using the ListAPIView generic class-based view.
    
+
    class PaginatedListView(ListAPIView):
+    model = ExampleModel
+    pagination_serializer_class = CustomPaginationSerializer
+    paginate_by = 10
+
    
+
    Creating custom pagination serializers
    
+
    Override pagination.BasePaginationSerializer, and set the fields that you want the serializer to return.
    
+
    For example.
    
+
    class CustomPaginationSerializer(pagination.BasePaginationSerializer):
+    next = pagination.NextURLField()
+    total_results = serializers.Field(source='paginator.count')
+
    
+        
    
+      
    
+    
    
+
+    
+    
+    
+    
+    
+    
+    
+    
+
diff --git a/api-guide/pagination.html b/api-guide/pagination.html
new file mode 100644
index 000000000..6b5b7789c
--- /dev/null
+++ b/api-guide/pagination.html
@@ -0,0 +1,226 @@
+
+
+    
+    Django REST framework
+    
+    
+    
+
+    
+    
+    
+    
+    
+
+    
+    
+  
+
+    
    
+      
    
+        
    
+            GitHub
+          
+            
+            
+            
+          
+          Django REST framework
+          
    
+            
+            
+          
    
+        
    
+      
    
+    
    
+
+    
    
+      
    
+        
    
+          
+        
    
+
+        
    
+          
    pagination.py
    
+
    Pagination
    
+
    
+
    Django provides a few classes that help you manage paginated data – that is, data that’s split across several pages, with “Previous/Next” links.
    
+
    — Django documentation
    
+
    
+
    REST framework includes a PaginationSerializer class that makes it easy to return paginated data in a way that can then be rendered to arbitrary media types. 
    
+
    Paginating basic data
    
+
    Let's start by taking a look at an example from the Django documentation.
    
+
    from django.core.paginator import Paginator
+objects = ['john', 'paul', 'george', 'ringo']
+paginator = Paginator(objects, 2)
+page = paginator.page(1)
+page.object_list
+# ['john', 'paul']
+
    
+
    At this point we've got a page object.  If we wanted to return this page object as a JSON response, we'd need to provide the client with context such as next and previous links, so that it would be able to page through the remaining results.
    
+
    from rest_framework.pagination import PaginationSerializer
+serializer = PaginationSerializer(instance=page)
+serializer.data
+# {'count': 4, 'next': '?page=2', 'previous': None, 'results': [u'john', u'paul']}
+
    
+
    The context argument of the PaginationSerializer class may optionally include the request.  If the request is included in the context then the next and previous links returned by the serializer will use absolute URLs instead of relative URLs.
    
+
    request = RequestFactory().get('/foobar')
+serializer = PaginationSerializer(instance=page, context={'request': request})
+serializer.data
+# {'count': 4, 'next': 'http://testserver/foobar?page=2', 'previous': None, 'results': [u'john', u'paul']}
+
    
+
    We could now return that data in a Response object, and it would be rendered into the correct media type.
    
+
    Paginating QuerySets
    
+
    Our first example worked because we were using primative objects.  If we wanted to paginate a queryset or other complex data, we'd need to specify a serializer to use to serialize the result set itself with.
    
+
    We can do this using the object_serializer_class attribute on the inner Meta class of the pagination serializer.  For example.
    
+
    class UserSerializer(serializers.ModelSerializer):
+    """
+    Serializes user querysets.
+    """
+    class Meta:
+        model = User
+        fields = ('username', 'email')
+
+class PaginatedUserSerializer(pagination.PaginationSerializer):
+    """
+    Serializes page objects of user querysets.
+    """
+    class Meta:
+        object_serializer_class = UserSerializer
+
    
+
    We could now use our pagination serializer in a view like this.
    
+
    @api_view('GET')
+def user_list(request):
+    queryset = User.objects.all()
+    paginator = Paginator(queryset, 20)
+
+    page = request.QUERY_PARAMS.get('page')
+    try:
+        users = paginator.page(page)
+    except PageNotAnInteger:
+        # If page is not an integer, deliver first page.
+        users = paginator.page(1)
+    except EmptyPage:
+        # If page is out of range (e.g. 9999), deliver last page of results.
+        users = paginator.page(paginator.num_pages)
+
+    serializer_context = {'request': request}
+    serializer = PaginatedUserSerializer(instance=users,
+                                         context=serializer_context)
+    return Response(serializer.data)
+
    
+
    Pagination in the generic views
    
+
    The generic class based views ListAPIView and ListCreateAPIView provide pagination of the returned querysets by default.  You can customise this behaviour by altering the pagination style, by modifying the default number of results, or by turning pagination off completely.
    
+
    The default pagination style may be set globally, using the PAGINATION_SERIALIZER and PAGINATE_BY settings.  For example.
    
+
    REST_FRAMEWORK = {
+    'PAGINATION_SERIALIZER': (
+        'example_app.pagination.CustomPaginationSerializer',
+    ),
+    'PAGINATE_BY': 10
+}
+
    
+
    You can also set the pagination style on a per-view basis, using the ListAPIView generic class-based view.
    
+
    class PaginatedListView(ListAPIView):
+    model = ExampleModel
+    pagination_serializer_class = CustomPaginationSerializer
+    paginate_by = 10
+
    
+
    For more complex requirements such as serialization that differs depending on the requested media type you can override the .get_paginate_by() and .get_pagination_serializer_class() methods.
    
+
    Creating custom pagination serializers
    
+
    To create a custom pagination serializer class you should override pagination.BasePaginationSerializer and set the fields that you want the serializer to return.
    
+
    For example, to nest a pair of links labelled 'prev' and 'next' you might use something like this.
    
+
    class LinksSerializer(serializers.Serializer):
+    next = pagination.NextURLField(source='*')
+    prev = pagination.PreviousURLField(source='*')
+
+class CustomPaginationSerializer(pagination.BasePaginationSerializer):
+    links = LinksSerializer(source='*')  # Takes the page object as the source
+    total_results = serializers.Field(source='paginator.count')
+
    
+        
    
+      
    
+    
    
+
+    
+    
+    
+    
+    
+    
+    
+    
+
diff --git a/api-guide/parsers.html b/api-guide/parsers.html
index 4c2eb7594..3c1bff46b 100644
--- a/api-guide/parsers.html
+++ b/api-guide/parsers.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -142,4 +143,4 @@ sending more complex data than simple forms
    
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/api-guide/permissions.html b/api-guide/permissions.html
index d92224afd..f621b24ec 100644
--- a/api-guide/permissions.html
+++ b/api-guide/permissions.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -195,4 +196,4 @@ def example_view(request, format=None):
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/api-guide/renderers.html b/api-guide/renderers.html
index 651e23992..68f4241a6 100644
--- a/api-guide/renderers.html
+++ b/api-guide/renderers.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -142,4 +143,4 @@
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/api-guide/requests.html b/api-guide/requests.html
index 3fae1f673..c7adb8a90 100644
--- a/api-guide/requests.html
+++ b/api-guide/requests.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -167,4 +168,4 @@
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/api-guide/responses.html b/api-guide/responses.html
index 7486a9631..81df658f3 100644
--- a/api-guide/responses.html
+++ b/api-guide/responses.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -94,10 +95,10 @@
           
@@ -111,12 +112,19 @@
 
    — Django documentation
    
 
 
    REST framework supports HTTP content negotiation by providing a Response class which allows you to return content that can be rendered into multiple content types, depending on the client request.
    
-
    The Response class subclasses Django's TemplateResponse.  Response objects are initialised with content, which should consist of native python primatives.  REST framework then uses standard HTTP content negotiation to determine how it should render the final response content.
    
-
    There's no requirement for you to use the Response class, you can also return regular HttpResponse objects from your views if you want, but it does provide a better interface for returning Web API responses.
    
-
    Response(content, headers=None,  renderers=None, view=None, format=None, status=None)
    
-
    .renderers
    
-
    .view
    
-
    .format
    
+
    The Response class subclasses Django's SimpleTemplateResponse.  Response objects are initialised with data, which should consist of native python primatives.  REST framework then uses standard HTTP content negotiation to determine how it should render the final response content.
    
+
    There's no requirement for you to use the Response class, you can also return regular HttpResponse objects from your views if you want, but it provides a nicer interface for returning Web API responses.
    
+
    Unless you want to heavily customize REST framework for some reason, you should always use an APIView class or @api_view function for views that return Response objects.  Doing so ensures that the view can perform content negotiation and select the appropriate renderer for the response, before it is returned from the view.
    
+
    Response(data, status=None, headers=None)
    
+
    Unlike regular HttpResponse objects, you do not instantiate Response objects with rendered content.  Instead you pass in unrendered data, which may consist of any python primatives.
    
+
    The renderers used by the Response class cannot natively handle complex datatypes such as Django model instances, so you need to serialize the data into primative datatypes before creating the Response object.
    
+
    You can use REST framework's Serializer classes to perform this data serialization, or use your own custom serialization.
    
+
    .data
    
+
    The unrendered content of a Request object can be accessed using the .data attribute.
    
+
    .content
    
+
    To access the rendered content of a Response object, you must first call .render().  You'll typically only need to do this in cases such as unit testing responses - when you return a Response from a view Django's response cycle will handle calling .render() for you.
    
+
    .renderer
    
+
    When you return a Response instance, the APIView class or @api_view decorator will select the appropriate renderer, and set the .renderer attribute on the Response, before returning it from the view.
    
         
    
       
    
     
    
@@ -139,4 +147,4 @@
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/api-guide/reverse.html b/api-guide/reverse.html
index 48c6152b9..cf383e547 100644
--- a/api-guide/reverse.html
+++ b/api-guide/reverse.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -155,4 +156,4 @@ class MyView(APIView):
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/api-guide/serializers.html b/api-guide/serializers.html
index bbbab7c1b..96e0c5a52 100644
--- a/api-guide/serializers.html
+++ b/api-guide/serializers.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -321,4 +322,4 @@ The ModelSerializer class lets you automatically create a Serialize
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/api-guide/settings.html b/api-guide/settings.html
index 900dfdc89..dda3523d8 100644
--- a/api-guide/settings.html
+++ b/api-guide/settings.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -224,4 +225,4 @@ print api_settings.DEFAULT_AUTHENTICATION
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/api-guide/status-codes.html b/api-guide/status-codes.html
index 216691737..c09f249c4 100644
--- a/api-guide/status-codes.html
+++ b/api-guide/status-codes.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -203,4 +204,4 @@ HTTP_511_NETWORD_AUTHENTICATION_REQUIRED
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/api-guide/throttling.html b/api-guide/throttling.html
index 5ff2e7092..243c766f8 100644
--- a/api-guide/throttling.html
+++ b/api-guide/throttling.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -243,4 +244,4 @@ class UploadView(APIView):
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/api-guide/views.html b/api-guide/views.html
index dea62322b..d03d6a02c 100644
--- a/api-guide/views.html
+++ b/api-guide/views.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -198,4 +199,4 @@ This method is used to enforce permissions and throttling, and perform content n
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/css/default.css b/css/default.css
index 213a700ed..49aac3a30 100644
--- a/css/default.css
+++ b/css/default.css
@@ -36,14 +36,14 @@ pre {
 }
 
 /* GitHub 'Star' badge */
-body.index #main-content iframe {
+body.index-page #main-content iframe {
     float: right;
     margin-top: -12px;
     margin-right: -15px;
 }
 
 /* Travis CI badge */
-body.index #main-content p:first-of-type {
+body.index-page #main-content p:first-of-type {
     float: right;
     margin-right: 8px;
     margin-top: -14px;
diff --git a/index.html b/index.html
index 6df00f0ad..dba8081ed 100644
--- a/index.html
+++ b/index.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -178,6 +179,7 @@ pip install -r optionals.txt
 
  • Authentication
    • 
 
  • Permissions
    • 
 
  • Throttling
    • 
+
  • Pagination
    • 
 
  • Content negotiation
    • 
 
  • Format suffixes
    • 
 
  • Returning URLs
    • 
@@ -244,4 +246,4 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/topics/browsable-api.html b/topics/browsable-api.html
index 93eeebf48..2b3dd9057 100644
--- a/topics/browsable-api.html
+++ b/topics/browsable-api.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -185,4 +186,4 @@
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/topics/changelog.html b/topics/changelog.html
index 89a6b4564..9da7a79f1 100644
--- a/topics/changelog.html
+++ b/topics/changelog.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -247,4 +248,4 @@
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/topics/contributing.html b/topics/contributing.html
index 9479f52bc..a4037b478 100644
--- a/topics/contributing.html
+++ b/topics/contributing.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -134,4 +135,4 @@
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/topics/credits.html b/topics/credits.html
index 33c741192..ebf06ae63 100644
--- a/topics/credits.html
+++ b/topics/credits.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
    
       
    
@@ -55,6 +55,7 @@
                   
  • Authentication
    • 
                   
  • Permissions
    • 
                   
  • Throttling
    • 
+                  
  • Pagination
    • 
                   
  • Content negotiation
    • 
                   
  • Format suffixes
    • 
                   
  • Returning URLs
    • 
@@ -146,12 +147,15 @@
 
  • Michael Barrett - phobologic
    • 
 
  • Mathieu Dhondt - laundromat
    • 
 
  • Johan Charpentier - cyberj
    • 
+
  • Jamie Matthews - j4mie
    • 
 
 
    Many thanks to everyone who's contributed to the project.
    
 
    Additional thanks
    
 
    The documentation is built with Bootstrap and Markdown.
    
 
    Project hosting is with GitHub.
    
 
    Continuous integration testing is managed with Travis CI.
    
+
    Various inspiration taken from the Piston, Tastypie and Dagny projects.
    
+
    Development of REST framework 2.0 was sponsored by DabApps.
    
 
    Contact
    
 
    To contact the author directly:
    
 
      
@@ -180,4 +184,4 @@
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/topics/csrf.html b/topics/csrf.html
index 39d0299ce..188e9553b 100644
--- a/topics/csrf.html
+++ b/topics/csrf.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
      
       
      
@@ -55,6 +55,7 @@
                   
    • Authentication
      • 
                   
    • Permissions
      • 
                   
    • Throttling
      • 
+                  
    • Pagination
      • 
                   
    • Content negotiation
      • 
                   
    • Format suffixes
      • 
                   
    • Returning URLs
      • 
@@ -132,4 +133,4 @@
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/topics/formoverloading.html b/topics/formoverloading.html
index 375c93400..31b8a68ff 100644
--- a/topics/formoverloading.html
+++ b/topics/formoverloading.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
      
       
      
@@ -55,6 +55,7 @@
                   
    • Authentication
      • 
                   
    • Permissions
      • 
                   
    • Throttling
      • 
+                  
    • Pagination
      • 
                   
    • Content negotiation
      • 
                   
    • Format suffixes
      • 
                   
    • Returning URLs
      • 
@@ -151,4 +152,4 @@
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/topics/rest-hypermedia-hateoas.html b/topics/rest-hypermedia-hateoas.html
index 1af060ad0..091b45cb1 100644
--- a/topics/rest-hypermedia-hateoas.html
+++ b/topics/rest-hypermedia-hateoas.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
      
       
      
@@ -55,6 +55,7 @@
                   
    • Authentication
      • 
                   
    • Permissions
      • 
                   
    • Throttling
      • 
+                  
    • Pagination
      • 
                   
    • Content negotiation
      • 
                   
    • Format suffixes
      • 
                   
    • Returning URLs
      • 
@@ -148,4 +149,4 @@ the Design of Network-based Software Architectures.
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/tutorial/1-serialization.html b/tutorial/1-serialization.html
index 829fee688..d4178070c 100644
--- a/tutorial/1-serialization.html
+++ b/tutorial/1-serialization.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
      
       
      
@@ -55,6 +55,7 @@
                   
    • Authentication
      • 
                   
    • Permissions
      • 
                   
    • Throttling
      • 
+                  
    • Pagination
      • 
                   
    • Content negotiation
      • 
                   
    • Format suffixes
      • 
                   
    • Returning URLs
      • 
@@ -343,4 +344,4 @@ urlpatterns = patterns('blog.views',
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/tutorial/2-requests-and-responses.html b/tutorial/2-requests-and-responses.html
index 9e0170702..e98f8d807 100644
--- a/tutorial/2-requests-and-responses.html
+++ b/tutorial/2-requests-and-responses.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
      
       
      
@@ -55,6 +55,7 @@
                   
    • Authentication
      • 
                   
    • Permissions
      • 
                   
    • Throttling
      • 
+                  
    • Pagination
      • 
                   
    • Content negotiation
      • 
                   
    • Format suffixes
      • 
                   
    • Returning URLs
      • 
@@ -240,4 +241,4 @@ urlpatterns = format_suffix_patterns(urlpatterns)
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/tutorial/3-class-based-views.html b/tutorial/3-class-based-views.html
index 9ba71d04a..67aa9fce1 100644
--- a/tutorial/3-class-based-views.html
+++ b/tutorial/3-class-based-views.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
      
       
      
@@ -55,6 +55,7 @@
                   
    • Authentication
      • 
                   
    • Permissions
      • 
                   
    • Throttling
      • 
+                  
    • Pagination
      • 
                   
    • Content negotiation
      • 
                   
    • Format suffixes
      • 
                   
    • Returning URLs
      • 
@@ -254,4 +255,4 @@ class CommentInstance(generics.InstanceAPIView):
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/tutorial/4-authentication-permissions-and-throttling.html b/tutorial/4-authentication-permissions-and-throttling.html
index af86ac8f0..845f988fc 100644
--- a/tutorial/4-authentication-permissions-and-throttling.html
+++ b/tutorial/4-authentication-permissions-and-throttling.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
      
       
      
@@ -55,6 +55,7 @@
                   
    • Authentication
      • 
                   
    • Permissions
      • 
                   
    • Throttling
      • 
+                  
    • Pagination
      • 
                   
    • Content negotiation
      • 
                   
    • Format suffixes
      • 
                   
    • Returning URLs
      • 
@@ -124,4 +125,4 @@
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/tutorial/5-relationships-and-hyperlinked-apis.html b/tutorial/5-relationships-and-hyperlinked-apis.html
index 36a404f6a..593574f2f 100644
--- a/tutorial/5-relationships-and-hyperlinked-apis.html
+++ b/tutorial/5-relationships-and-hyperlinked-apis.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
      
       
      
@@ -55,6 +55,7 @@
                   
    • Authentication
      • 
                   
    • Permissions
      • 
                   
    • Throttling
      • 
+                  
    • Pagination
      • 
                   
    • Content negotiation
      • 
                   
    • Format suffixes
      • 
                   
    • Returning URLs
      • 
@@ -130,4 +131,4 @@
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+
diff --git a/tutorial/6-resource-orientated-projects.html b/tutorial/6-resource-orientated-projects.html
index 62ed50f9f..0bec7aafb 100644
--- a/tutorial/6-resource-orientated-projects.html
+++ b/tutorial/6-resource-orientated-projects.html
@@ -16,7 +16,7 @@
     
-  
+  
 
     
      
       
      
@@ -55,6 +55,7 @@
                   
    • Authentication
      • 
                   
    • Permissions
      • 
                   
    • Throttling
      • 
+                  
    • Pagination
      • 
                   
    • Content negotiation
      • 
                   
    • Format suffixes
      • 
                   
    • Returning URLs
      • 
@@ -189,4 +190,4 @@ urlpatterns = router.urlpatterns
         event.stopPropagation();
       });
     
-
\ No newline at end of file
+