Links to source files in docs

tomchristie · tomchristie · commit 247696e820df · 2012-09-08T22:06:13.000+01:00
diff --git a/docs/api-guide/authentication.md b/docs/api-guide/authentication.md
@@ -1,3 +1,5 @@
+<a class="github" href="authentication.py"></a>
+
 # 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.
diff --git a/docs/api-guide/exceptions.md b/docs/api-guide/exceptions.md
@@ -1,3 +1,5 @@
+<a class="github" href="exceptions.py"></a>
+
 # Exceptions
 
 
diff --git a/docs/api-guide/parsers.md b/docs/api-guide/parsers.md
@@ -1,3 +1,5 @@
+<a class="github" href="parsers.py"></a>
+
 # Parsers
 
 ## .parse(request)
diff --git a/docs/api-guide/permissions.md b/docs/api-guide/permissions.md
@@ -1 +1,3 @@
+<a class="github" href="permissions.py"></a>
 
+# Permissions
diff --git a/docs/api-guide/renderers.md b/docs/api-guide/renderers.md
@@ -1,3 +1,5 @@
+<a class="github" href="renderers.py"></a>
+
 # Renderers
 
 ## .render(response)
diff --git a/docs/api-guide/requests.md b/docs/api-guide/requests.md
@@ -1,3 +1,5 @@
+<a class="github" href="request.py"></a>
+
 # Requests
 
 > If you're doing REST-based web service stuff ... you should ignore request.POST.
diff --git a/docs/api-guide/responses.md b/docs/api-guide/responses.md
@@ -1,3 +1,5 @@
+<a class="github" href="response.py"></a>
+
 # 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.
diff --git a/docs/api-guide/reverse.md b/docs/api-guide/reverse.md
@@ -1,3 +1,5 @@
+<a class="github" href="reverse.py"></a>
+
 # 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.
diff --git a/docs/api-guide/serializers.md b/docs/api-guide/serializers.md
@@ -1,3 +1,5 @@
+<a class="github" href="serializers.py"></a>
+
 # Serializers
 
 > Expanding the usefulness of the serializers is something that we would
diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md
@@ -1,3 +1,5 @@
+<a class="github" href="settings.py"></a>
+
 # Settings
 
 Configuration for REST framework is all namespaced inside the `API_SETTINGS` setting.
diff --git a/docs/api-guide/status-codes.md b/docs/api-guide/status-codes.md
@@ -1,3 +1,5 @@
+<a class="github" href="status.py"></a>
+
 # 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.
diff --git a/docs/api-guide/throttling.md b/docs/api-guide/throttling.md
@@ -1 +1,3 @@
+<a class="github" href="throttling.py"></a>
 
+# Throttling
diff --git a/docs/api-guide/views.md b/docs/api-guide/views.md
@@ -1,3 +1,5 @@
+<a class="github" href="views.py"></a>
+
 > Django's class based views are a welcome departure from the old-style views.
 >
 > &mdash; [Reinout van Rees][cite]
diff --git a/docs/static/css/drf-styles.css b/docs/static/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;
diff --git a/mkdocs.py b/mkdocs.py
@@ -24,6 +24,7 @@
 
 main_header = '<li class="main"><a href="#{{ anchor }}">{{ title }}</a></li>'
 sub_header = '<li><a href="#{{ anchor }}">{{ title }}</a></li>'
+code_label = r'<a class="github" href="https://github.com/tomchristie/django-rest-framework/blob/restframework2/djangorestframework/\1"><span class="label label-info">\1</span></a>'
 
 page = open(os.path.join(docs_dir, 'template.html'), 'r').read()
 
@@ -68,4 +69,5 @@
         output = re.sub(r'a href="([^"]*)\.md"', r'a href="\1%s"' % suffix, output)
         output = re.sub(r'<pre><code>:::bash', r'<pre class="prettyprint lang-bsh">', output)
         output = re.sub(r'<pre>', r'<pre class="prettyprint lang-py">', output)
+        output = re.sub(r'<a class="github" href="([^"]*)"></a>', code_label, output)
         open(build_file, 'w').write(output.encode('utf-8'))

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+<a class="github" href="authentication.py"></a>`
	`2`	`+`
`1`	`3`	`# Authentication`
`2`	`4`
`3`	`5`	`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.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+<a class="github" href="exceptions.py"></a>`
	`2`	`+`
`1`	`3`	`# Exceptions`
`2`	`4`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
	`1`	`+<a class="github" href="permissions.py"></a>`
`1`	`2`
	`3`	`+# Permissions`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+<a class="github" href="renderers.py"></a>`
	`2`	`+`
`1`	`3`	`# Renderers`
`2`	`4`
`3`	`5`	`## .render(response)`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+<a class="github" href="request.py"></a>`
	`2`	`+`
`1`	`3`	`# Requests`
`2`	`4`
`3`	`5`	`> If you're doing REST-based web service stuff ... you should ignore request.POST.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+<a class="github" href="response.py"></a>`
	`2`	`+`
`1`	`3`	`# Responses`
`2`	`4`
`3`	`5`	`> 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.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+<a class="github" href="reverse.py"></a>`
	`2`	`+`
`1`	`3`	`# Returning URIs from your Web APIs`
`2`	`4`
`3`	`5`	`> The central feature that distinguishes the REST architectural style from other network-based styles is its emphasis on a uniform interface between components.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+<a class="github" href="serializers.py"></a>`
	`2`	`+`
`1`	`3`	`# Serializers`
`2`	`4`
`3`	`5`	`> Expanding the usefulness of the serializers is something that we would`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+<a class="github" href="settings.py"></a>`
	`2`	`+`
`1`	`3`	`# Settings`
`2`	`4`
`3`	`5`	Configuration for REST framework is all namespaced inside the `API_SETTINGS` setting.