From 44eea9497daef30c74a13267059653aacc3a9242 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Sat, 8 Sep 2012 22:06:49 +0100 Subject: [PATCH] Add links to source files in docs --- api-guide/authentication.html | 3 ++- api-guide/exceptions.html | 3 ++- api-guide/parsers.html | 3 ++- api-guide/permissions.html | 6 ++++-- api-guide/renderers.html | 3 ++- api-guide/requests.html | 3 ++- api-guide/responses.html | 3 ++- api-guide/reverse.html | 3 ++- api-guide/serializers.html | 3 ++- api-guide/settings.html | 3 ++- api-guide/status-codes.html | 3 ++- api-guide/throttling.html | 6 ++++-- api-guide/views.html | 3 ++- css/drf-styles.css | 12 ++++++++++-- 14 files changed, 40 insertions(+), 17 deletions(-) diff --git a/api-guide/authentication.html b/api-guide/authentication.html index 8a7f36f8f..60fabad9e 100644 --- a/api-guide/authentication.html +++ b/api-guide/authentication.html @@ -102,7 +102,8 @@
-

Authentication

+

authentication.py

+

Authentication

Authentication is the mechanism of associating an incoming request with a set of identifying credentials, such as the user the request came from, or the token that it was signed with. The permission and throttling policies can then use those credentials to determine if the request should be permitted.

REST framework provides a number of authentication policies out of the box, and also allows you to implement custom policies.

Authentication will run the first time either the request.user or request.auth properties are accessed, and determines how those properties are initialized.

diff --git a/api-guide/exceptions.html b/api-guide/exceptions.html index b8d5e1694..b200205cd 100644 --- a/api-guide/exceptions.html +++ b/api-guide/exceptions.html @@ -95,7 +95,8 @@
-

Exceptions

+

exceptions.py

+

Exceptions

diff --git a/api-guide/parsers.html b/api-guide/parsers.html index 381e0396d..9da2032f2 100644 --- a/api-guide/parsers.html +++ b/api-guide/parsers.html @@ -96,7 +96,8 @@
-

Parsers

+

parsers.py

+

Parsers

.parse(request)

diff --git a/api-guide/permissions.html b/api-guide/permissions.html index 9c6bc8c65..cfd4e69ec 100644 --- a/api-guide/permissions.html +++ b/api-guide/permissions.html @@ -88,13 +88,15 @@
- +

permissions.py

+

Permissions

diff --git a/api-guide/renderers.html b/api-guide/renderers.html index e953371e5..6b6126780 100644 --- a/api-guide/renderers.html +++ b/api-guide/renderers.html @@ -96,7 +96,8 @@
-

Renderers

+

renderers.py

+

Renderers

.render(response)

diff --git a/api-guide/requests.html b/api-guide/requests.html index 2fba44fe4..dfcb96e29 100644 --- a/api-guide/requests.html +++ b/api-guide/requests.html @@ -104,7 +104,8 @@
-

Requests

+

request.py

+

Requests

If you're doing REST-based web service stuff ... you should ignore request.POST.

— Malcom Tredinnick, Django developers group

diff --git a/api-guide/responses.html b/api-guide/responses.html index 75758a91f..75ff96d3b 100644 --- a/api-guide/responses.html +++ b/api-guide/responses.html @@ -99,7 +99,8 @@
-

Responses

+

response.py

+

Responses

Unlike basic HttpResponse objects, TemplateResponse objects retain the details of the context that was provided by the view to compute the response. The final output of the response is not computed until it is needed, later in the response process.

— Django documentation

diff --git a/api-guide/reverse.html b/api-guide/reverse.html index 65f435fb6..2e31abcdd 100644 --- a/api-guide/reverse.html +++ b/api-guide/reverse.html @@ -97,7 +97,8 @@
-

Returning URIs from your Web APIs

+

reverse.py

+

Returning URIs from your Web APIs

The central feature that distinguishes the REST architectural style from other network-based styles is its emphasis on a uniform interface between components.

— Roy Fielding, Architectural Styles and the Design of Network-based Software Architectures

diff --git a/api-guide/serializers.html b/api-guide/serializers.html index 8c508bd16..75debbb3d 100644 --- a/api-guide/serializers.html +++ b/api-guide/serializers.html @@ -107,7 +107,8 @@
-

Serializers

+

serializers.py

+

Serializers

Expanding the usefulness of the serializers is something that we would like to address. However, it's not a trivial problem, and it diff --git a/api-guide/settings.html b/api-guide/settings.html index 4f1fa002d..0ee1d9f08 100644 --- a/api-guide/settings.html +++ b/api-guide/settings.html @@ -110,7 +110,8 @@

-

Settings

+

settings.py

+

Settings

Configuration for REST framework is all namespaced inside the API_SETTINGS setting.

For example your project's settings.py file might look like this:

API_SETTINGS = {
diff --git a/api-guide/status-codes.html b/api-guide/status-codes.html
index 96948af61..2db8a6c9a 100644
--- a/api-guide/status-codes.html
+++ b/api-guide/status-codes.html
@@ -100,7 +100,8 @@
-

Status Codes

+

status.py

+

Status Codes

418 I'm a teapot - Any attempt to brew coffee with a teapot should result in the error code "418 I'm a teapot". The resulting entity body MAY be short and stout.

— RFC 2324, Hyper Text Coffee Pot Control Protocol

diff --git a/api-guide/throttling.html b/api-guide/throttling.html index 9c6bc8c65..baab07b77 100644 --- a/api-guide/throttling.html +++ b/api-guide/throttling.html @@ -88,13 +88,15 @@
- +

throttling.py

+

Throttling

diff --git a/api-guide/views.html b/api-guide/views.html index 3a59b8c85..b98025016 100644 --- a/api-guide/views.html +++ b/api-guide/views.html @@ -105,7 +105,8 @@
-
+

views.py

+

Django's class based views are a welcome departure from the old-style views.

— Reinout van Rees

diff --git a/css/drf-styles.css b/css/drf-styles.css index ecbd415c1..a0566790e 100644 --- a/css/drf-styles.css +++ b/css/drf-styles.css @@ -14,6 +14,14 @@ pre { font-size: 12px; } +a.github { + float: right; + margin-top: -12px; +} + +a.github:hover { + text-decoration: none; +} /* Preserve the spacing of the navbar across different screen sizes. */ .navbar-inner { @@ -66,7 +74,7 @@ blockquote { border-left: none; } - blockquote:before { +blockquote:before { display: block; content: "\201C"; font-size: 80px; @@ -76,7 +84,7 @@ blockquote { color: #7a7a7a; } - blockquote p:last-child { +blockquote p:last-child { color: #999999; font-size: 14px; display: block;