aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTom Christie2012-10-05 15:22:30 +0100
committerTom Christie2012-10-05 15:22:30 +0100
commit84958d131a29d80acea94dec5260b484556e73d0 (patch)
tree2738af716dd989f9fb08fdb979dbea9bc6940fc4
parent9d8bce8f5b0915223f57d9fe3d4b63029cfc64c2 (diff)
downloaddjango-rest-framework-84958d131a29d80acea94dec5260b484556e73d0.tar.bz2
Doc style tweaks
-rw-r--r--docs/api-guide/responses.md4
-rw-r--r--docs/api-guide/views.md6
-rw-r--r--docs/static/css/default.css24
-rw-r--r--docs/template.html14
-rw-r--r--docs/tutorial/1-serialization.md3
5 files changed, 44 insertions, 7 deletions
diff --git a/docs/api-guide/responses.md b/docs/api-guide/responses.md
index 724428f8..b5ad843b 100644
--- a/docs/api-guide/responses.md
+++ b/docs/api-guide/responses.md
@@ -56,7 +56,7 @@ The `Response` class extends `SimpleTemplateResponse`, and all the usual methods
## .data
-The unrendered content of a `Request` object can be accessed using the `.data` attribute.
+The unrendered content of a `Request` object.
## .status_code
@@ -64,7 +64,7 @@ The numeric status code of the HTTP response.
## .content
-The rendered content of the response. `.render()` must have been called before `.content` can be accessed.
+The rendered content of the response. The `.render()` method must have been called before `.content` can be accessed.
## .template_name
diff --git a/docs/api-guide/views.md b/docs/api-guide/views.md
index a615026f..cbfa2e28 100644
--- a/docs/api-guide/views.md
+++ b/docs/api-guide/views.md
@@ -83,7 +83,7 @@ The following methods are called before dispatching to the handler method.
The following methods are called directly by the view's `.dispatch()` method.
These perform any actions that need to occur before or after calling the handler methods such as `.get()`, `.post()`, `put()` and `.delete()`.
-### .initial(self, request, *args, **kwargs)
+### .initial(self, request, \*args, **kwargs)
Performs any actions that need to occur before the handler method gets called.
This method is used to enforce permissions and throttling, and perform content negotiation.
@@ -98,13 +98,13 @@ The default implementation handles any subclass of `rest_framework.exceptions.AP
If you need to customize the error responses your API returns you should subclass this method.
-### .initialize_request(self, request, *args, **kwargs)
+### .initialize_request(self, request, \*args, **kwargs)
Ensures that the request object that is passed to the handler method is an instance of `Request`, rather than the usual Django `HttpRequest`.
You won't typically need to override this method.
-### .finalize_response(self, request, response, *args, **kwargs)
+### .finalize_response(self, request, response, \*args, **kwargs)
Ensures that any `Response` object returned from the handler method will be rendered into the correct content type, as determined by the content negotation.
diff --git a/docs/static/css/default.css b/docs/static/css/default.css
index 5a73fb99..8401687d 100644
--- a/docs/static/css/default.css
+++ b/docs/static/css/default.css
@@ -61,6 +61,30 @@ a.github:hover {
text-decoration: none;
}
+/* Footer */
+/*
+.footer p {
+ text-align: center;
+ color: gray;
+ border-top: 1px solid #DDD;
+ padding-top: 10px;
+}
+
+.footer a {
+ color: gray;
+ font-weight: bold;
+}
+
+.footer a:hover {
+ color: gray;
+}
+*/
+
+/* */
+body hr {
+ border-top: 1px dotted #A30000
+}
+
/* Force TOC text to not overrun */
#table-of-contents {
overflow: hidden;
diff --git a/docs/template.html b/docs/template.html
index b6d2adf2..dc401d89 100644
--- a/docs/template.html
+++ b/docs/template.html
@@ -89,6 +89,8 @@
</div>
</div>
+ <div id="wrap">
+
<div class="container-fluid">
<div class="row-fluid">
@@ -104,9 +106,19 @@
{{ content }}
</div><!--/span-->
</div><!--/row-->
-
</div><!--/.fluid-container-->
+ <div id="push"></div>
+ </div>
+
+ <!--
+ <div class="row footer">
+ <div class="span12">
+ <p>Sponsored by <a href="http://dabapps.com/">Dab Apps</a>.</a></p>
+ </div>
+ </div>
+ -->
+
<!-- Le javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
diff --git a/docs/tutorial/1-serialization.md b/docs/tutorial/1-serialization.md
index 5d830315..6744eafe 100644
--- a/docs/tutorial/1-serialization.md
+++ b/docs/tutorial/1-serialization.md
@@ -25,6 +25,7 @@ Now that we're inside a virtualenv environment, we can install our package requi
Okay, we're ready to get coding.
To get started, let's create a new project to work with.
+ cd ~
django-admin.py startproject tutorial
cd tutorial
@@ -78,7 +79,7 @@ Don't forget to sync the database for the first time.
## Creating a Serializer class
-We're going to create a simple Web API that we can use to edit these comment objects with. The first thing we need is a way of serializing and deserializing the objects into representations such as `json`. We do this by declaring serializers that work very similarly to Django's forms. Create a file in the project named `serializers.py` and add the following.
+We're going to create a simple Web API that we can use to edit these comment objects with. The first thing we need is a way of serializing and deserializing the objects into representations such as `json`. We do this by declaring serializers that work very similarly to Django's forms. Create a file in the `blog` directory named `serializers.py` and add the following.
from blog import models
from rest_framework import serializers