Update documentation

5816c561 · Tom Christie · 3b2fc6f0 · 5816c561 · 5816c561 · 5816c561
Commit 5816c561 authored Dec 10, 2014 by Tom Christie
48 changed files
--- a/api-guide/authentication/index.html
+++ b/api-guide/authentication/index.html
@@ -779,6 +779,7 @@ class ExampleAuthentication(authentication.BaseAuthentication):
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/content-negotiation/index.html
+++ b/api-guide/content-negotiation/index.html
@@ -484,6 +484,7 @@ class NoNegotiationView(APIView):
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/exceptions/index.html
+++ b/api-guide/exceptions/index.html
@@ -559,6 +559,7 @@ class ServiceUnavailable(APIException):
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/fields/index.html
+++ b/api-guide/fields/index.html
@@ -971,6 +971,7 @@ def to_internal_value(self, data):
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/filtering/index.html
+++ b/api-guide/filtering/index.html
@@ -774,6 +774,7 @@ class ProductFilter(django_filters.FilterSet):
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/format-suffixes/index.html
+++ b/api-guide/format-suffixes/index.html
@@ -450,6 +450,7 @@ def comment_list(request, format=None):
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/generic-views/index.html
+++ b/api-guide/generic-views/index.html
@@ -787,6 +787,7 @@ class BaseRetrieveUpdateDestroyView(MultipleFieldLookupMixin,
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/pagination/index.html
+++ b/api-guide/pagination/index.html
@@ -558,6 +558,7 @@ class CustomPaginationSerializer(pagination.BasePaginationSerializer):
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/parsers/index.html
+++ b/api-guide/parsers/index.html
@@ -598,6 +598,7 @@ def parse(self, stream, media_type=None, parser_context=None):
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/permissions/index.html
+++ b/api-guide/permissions/index.html
@@ -650,6 +650,7 @@ class BlacklistPermission(permissions.BasePermission):
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/relations/index.html
+++ b/api-guide/relations/index.html
@@ -866,6 +866,7 @@ attributes are not configured to correctly match the URL conf.</p>
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/renderers/index.html
+++ b/api-guide/renderers/index.html
@@ -817,6 +817,7 @@ In this case you can underspecify the media types it should respond to, by using
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/requests/index.html
+++ b/api-guide/requests/index.html
@@ -564,6 +564,7 @@
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/responses/index.html
+++ b/api-guide/responses/index.html
@@ -505,6 +505,7 @@ response['Cache-Control'] = 'no-cache'
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/reverse/index.html
+++ b/api-guide/reverse/index.html
@@ -438,6 +438,7 @@ class APIRootView(APIView):
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/routers/index.html
+++ b/api-guide/routers/index.html
@@ -653,6 +653,7 @@ app.router.register_model(MyModel)
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/serializers/index.html
+++ b/api-guide/serializers/index.html
@@ -1322,6 +1322,7 @@ def all_high_scores(request):
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/settings/index.html
+++ b/api-guide/settings/index.html
@@ -695,6 +695,7 @@ If set to <code>None</code> then generic filtering is disabled.</p>
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/status-codes/index.html
+++ b/api-guide/status-codes/index.html
@@ -510,6 +510,7 @@ is_server_error()   # 5xx
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/testing/index.html
+++ b/api-guide/testing/index.html
@@ -672,6 +672,7 @@ self.assertEqual(response.content, '{"username": "lauren", "id": 4}')
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/throttling/index.html
+++ b/api-guide/throttling/index.html
@@ -581,6 +581,7 @@ class UploadView(APIView):
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/validators/index.html
+++ b/api-guide/validators/index.html
@@ -620,6 +620,7 @@ It has two required arguments, and a single optional <code>messages</code> argum
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/views/index.html
+++ b/api-guide/views/index.html
@@ -549,6 +549,7 @@ def view(request):
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/api-guide/viewsets/index.html
+++ b/api-guide/viewsets/index.html
@@ -634,6 +634,7 @@ class UserViewSet(viewsets.ModelViewSet):
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/index.html
+++ b/index.html
@@ -688,6 +688,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</p>
  <script src="./js/jquery-1.8.1-min.js"></script>
  <script src="./js/prettify-1.0.js"></script>
  <script src="./js/bootstrap-2.1.1-min.js"></script>
+  <script src="./js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/js/theme.js
+++ b/js/theme.js
+$(function(){
+
+    $('pre code').parent().addClass('prettyprint well');
+
+});
--- a/topics/2.2-announcement/index.html
+++ b/topics/2.2-announcement/index.html
@@ -510,6 +510,7 @@ serializer.data
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/topics/2.3-announcement/index.html
+++ b/topics/2.3-announcement/index.html
@@ -647,6 +647,7 @@ urlpatterns = [
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/topics/2.4-announcement/index.html
+++ b/topics/2.4-announcement/index.html
@@ -533,6 +533,7 @@ The lowest supported version of Django is now 1.4.2.</p>
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/topics/3.0-announcement/index.html
+++ b/topics/3.0-announcement/index.html
@@ -426,7 +426,7 @@
 <hr />
 <h4 id="rest-framework-under-the-hood">REST framework: Under the hood.</h4>
 <p>This talk from the <a href="http://www.djangounderthehood.com/">Django: Under the Hood</a> event in Amsterdam, Nov 2014, gives some good background context on the design decisions behind 3.0.</p>
-<iframe width="560" height="315" src="//www.youtube.com/embed/3cSsbe-tA0E" frameborder="0" allowfullscreen></iframe>
+<iframe style="display: block; margin: 0 auto 0 auto" width="560" height="315" src="//www.youtube.com/embed/3cSsbe-tA0E" frameborder="0" allowfullscreen></iframe>

 <hr />
 <p><em>Below is an in-depth guide to the API changes and migration notes for 3.0.</em></p>
@@ -1165,6 +1165,7 @@ amount = serializers.DecimalField(
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/topics/ajax-csrf-cors/index.html
+++ b/topics/ajax-csrf-cors/index.html
@@ -420,6 +420,7 @@
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/topics/browsable-api/index.html
+++ b/topics/browsable-api/index.html
@@ -505,6 +505,7 @@
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/topics/browser-enhancements/index.html
+++ b/topics/browser-enhancements/index.html
@@ -463,6 +463,7 @@ as well as how to support content types other than form-encoded data.</p>
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/topics/contributing/index.html
+++ b/topics/contributing/index.html
@@ -582,6 +582,7 @@ More text...
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/topics/credits/index.html
+++ b/topics/credits/index.html
@@ -590,6 +590,7 @@
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/topics/documenting-your-api/index.html
+++ b/topics/documenting-your-api/index.html
@@ -459,6 +459,7 @@
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/topics/kickstarter-announcement/index.html
+++ b/topics/kickstarter-announcement/index.html
--- a/topics/release-notes/index.html
+++ b/topics/release-notes/index.html
@@ -962,6 +962,7 @@
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/topics/rest-framework-2-announcement/index.html
+++ b/topics/rest-framework-2-announcement/index.html
@@ -469,6 +469,7 @@
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/topics/rest-hypermedia-hateoas/index.html
+++ b/topics/rest-hypermedia-hateoas/index.html
@@ -423,6 +423,7 @@ the Design of Network-based Software Architectures</a>.</li>
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/topics/third-party-resources/index.html
+++ b/topics/third-party-resources/index.html
@@ -603,6 +603,7 @@ You probably want to also tag the version now:
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/tutorial/1-serialization/index.html
+++ b/tutorial/1-serialization/index.html
@@ -747,6 +747,7 @@ HTTP/1.1 200 OK
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/tutorial/2-requests-and-responses/index.html
+++ b/tutorial/2-requests-and-responses/index.html
@@ -583,6 +583,7 @@ http --json POST http://127.0.0.1:8000/snippets/ code="print 456"
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/tutorial/3-class-based-views/index.html
+++ b/tutorial/3-class-based-views/index.html
@@ -527,6 +527,7 @@ class SnippetDetail(generics.RetrieveUpdateDestroyAPIView):
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/tutorial/4-authentication-and-permissions/index.html
+++ b/tutorial/4-authentication-and-permissions/index.html
@@ -594,6 +594,7 @@ class IsOwnerOrReadOnly(permissions.BasePermission):
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/tutorial/5-relationships-and-hyperlinked-apis/index.html
+++ b/tutorial/5-relationships-and-hyperlinked-apis/index.html
@@ -537,6 +537,7 @@ urlpatterns += [
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/tutorial/6-viewsets-and-routers/index.html
+++ b/tutorial/6-viewsets-and-routers/index.html
@@ -527,6 +527,7 @@ urlpatterns = [
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()

--- a/tutorial/quickstart/index.html
+++ b/tutorial/quickstart/index.html
@@ -573,6 +573,7 @@ HTTP/1.1 200 OK
  <script src="../../js/jquery-1.8.1-min.js"></script>
  <script src="../../js/prettify-1.0.js"></script>
  <script src="../../js/bootstrap-2.1.1-min.js"></script>
+  <script src="../../js/theme.js"></script>

  <script>
    //$('.side-nav').scrollspy()