aboutsummaryrefslogtreecommitdiffstats
path: root/docs_theme
diff options
context:
space:
mode:
authorTom Christie2014-11-25 16:27:00 +0000
committerTom Christie2014-11-25 16:27:00 +0000
commitf13c0ebe69f92ecad7e84257b3baf2ccafe69b3e (patch)
tree5de4f2bcbd973513197c809b301f05f21b9db325 /docs_theme
parent8c91e7b742067b6d4e4ed6d476bfe2cf5839ac8b (diff)
parentb733f85ff1e3f70e9f5dee6f52bebe861bc0f411 (diff)
downloaddjango-rest-framework-f13c0ebe69f92ecad7e84257b3baf2ccafe69b3e.tar.bz2
Merge master
Diffstat (limited to 'docs_theme')
-rw-r--r--docs_theme/404.html216
-rw-r--r--docs_theme/base.html196
-rw-r--r--docs_theme/nav.html47
3 files changed, 459 insertions, 0 deletions
diff --git a/docs_theme/404.html b/docs_theme/404.html
new file mode 100644
index 00000000..44993e37
--- /dev/null
+++ b/docs_theme/404.html
@@ -0,0 +1,216 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <meta charset="utf-8">
+ <title>Django REST framework - 404 - Page not found</title>
+ <link href="http://www.django-rest-framework.org/img/favicon.ico" rel="icon" type="image/x-icon">
+ <link rel="canonical" href="http://www.django-rest-framework.org/404" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <meta name="description" content="Django, API, REST, 404 - Page not found">
+ <meta name="author" content="Tom Christie">
+
+ <!-- Le styles -->
+ <link href="http://www.django-rest-framework.org/css/prettify.css" rel="stylesheet">
+ <link href="http://www.django-rest-framework.org/css/bootstrap.css" rel="stylesheet">
+ <link href="http://www.django-rest-framework.org/css/bootstrap-responsive.css" rel="stylesheet">
+ <link href="http://www.django-rest-framework.org/css/default.css" rel="stylesheet">
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-18852272-2']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script');
+ ga.type = 'text/javascript';
+ ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0];
+ s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+</head>
+
+<body onload="prettyPrint()" class="404-page">
+
+ <div class="wrapper">
+
+ <div class="navbar navbar-inverse navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a class="repo-link btn btn-primary btn-small" href="https://github.com/tomchristie/django-rest-framework/tree/master">GitHub</a>
+ <a class="repo-link btn btn-inverse btn-small disabled" href="#">Next <i class="icon-arrow-right icon-white"></i></a>
+ <a class="repo-link btn btn-inverse btn-small disabled" href="#"><i class="icon-arrow-left icon-white"></i> Previous</a>
+ <a class="repo-link btn btn-inverse btn-small" href="#searchModal" data-toggle="modal"><i class="icon-search icon-white"></i> Search</a>
+ <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+ <a class="brand" href="http://www.django-rest-framework.org">Django REST framework</a>
+ <div class="nav-collapse collapse">
+ <ul class="nav">
+ <li><a href="http://www.django-rest-framework.org">Home</a></li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Tutorial <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="http://www.django-rest-framework.org/tutorial/quickstart">Quickstart</a></li>
+ <li><a href="http://www.django-rest-framework.org/tutorial/1-serialization">1 - Serialization</a></li>
+ <li><a href="http://www.django-rest-framework.org/tutorial/2-requests-and-responses">2 - Requests and responses</a></li>
+ <li><a href="http://www.django-rest-framework.org/tutorial/3-class-based-views">3 - Class based views</a></li>
+ <li><a href="http://www.django-rest-framework.org/tutorial/4-authentication-and-permissions">4 - Authentication and permissions</a></li>
+ <li><a href="http://www.django-rest-framework.org/tutorial/5-relationships-and-hyperlinked-apis">5 - Relationships and hyperlinked APIs</a></li>
+ <li><a href="http://www.django-rest-framework.org/tutorial/6-viewsets-and-routers">6 - Viewsets and routers</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API Guide <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="http://www.django-rest-framework.org/api-guide/requests">Requests</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/responses">Responses</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/views">Views</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/generic-views">Generic views</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/viewsets">Viewsets</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/routers">Routers</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/parsers">Parsers</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/renderers">Renderers</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/serializers">Serializers</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/fields">Serializer fields</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/relations">Serializer relations</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/authentication">Authentication</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/permissions">Permissions</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/throttling">Throttling</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/filtering">Filtering</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/pagination">Pagination</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/content-negotiation">Content negotiation</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/format-suffixes">Format suffixes</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/reverse">Returning URLs</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/exceptions">Exceptions</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/status-codes">Status codes</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/testing">Testing</a></li>
+ <li><a href="http://www.django-rest-framework.org/api-guide/settings">Settings</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Topics <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="http://www.django-rest-framework.org/topics/documenting-your-api">Documenting your API</a></li>
+ <li><a href="http://www.django-rest-framework.org/topics/ajax-csrf-cors">AJAX, CSRF & CORS</a></li>
+ <li><a href="http://www.django-rest-framework.org/topics/browser-enhancements">Browser enhancements</a></li>
+ <li><a href="http://www.django-rest-framework.org/topics/browsable-api">The Browsable API</a></li>
+ <li><a href="http://www.django-rest-framework.org/topics/rest-hypermedia-hateoas">REST, Hypermedia & HATEOAS</a></li>
+ <li><a href="http://www.django-rest-framework.org/topics/rest-framework-2-announcement">2.0 Announcement</a></li>
+ <li><a href="http://www.django-rest-framework.org/topics/2.2-announcement">2.2 Announcement</a></li>
+ <li><a href="http://www.django-rest-framework.org/topics/2.3-announcement">2.3 Announcement</a></li>
+ <li><a href="http://www.django-rest-framework.org/topics/release-notes">Release Notes</a></li>
+ <li><a href="http://www.django-rest-framework.org/topics/credits">Credits</a></li>
+ </ul>
+ </li>
+ </ul>
+ <ul class="nav pull-right">
+ <!-- TODO
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Version: 2.0.0 <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="#">Trunk</a></li>
+ <li><a href="#">2.0.0</a></li>
+ </ul>
+ </li>
+ -->
+ </ul>
+ </div>
+ <!--/.nav-collapse -->
+ </div>
+ </div>
+ </div>
+
+ <div class="body-content">
+ <div class="container-fluid">
+ <!-- Search Modal -->
+ <div id="searchModal" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true">
+ <div class="modal-header">
+ <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
+ <h3 id="myModalLabel">Documentation search</h3>
+ </div>
+ <div class="modal-body">
+ <!-- Custom google search -->
+ <script>
+ (function() {
+ var cx = '015016005043623903336:rxraeohqk6w';
+ var gcse = document.createElement('script');
+ gcse.type = 'text/javascript';
+ gcse.async = true;
+ gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
+ '//www.google.com/cse/cse.js?cx=' + cx;
+ var s = document.getElementsByTagName('script')[0];
+ s.parentNode.insertBefore(gcse, s);
+ })();
+ </script>
+ <gcse:search></gcse:search>
+ </div>
+ <div class="modal-footer">
+ <button class="btn" data-dismiss="modal" aria-hidden="true">Close</button>
+ </div>
+ </div>
+
+ <div class="row-fluid">
+ <div id="main-content" class="span12">
+ <h1 id="404-page-not-found" style="text-align: center">404</h1>
+ <p style="text-align: center"><strong>Page not found</strong>
+ </p>
+ <p style="text-align: center">Try the <a href="http://www.django-rest-framework.org/">homepage</a>, or <a href="#searchModal" data-toggle="modal">search the documentation</a>.</p>
+ </div>
+ <!--/span-->
+ </div>
+ <!--/row-->
+ </div>
+ <!--/.fluid-container-->
+ </div>
+ <!--/.body content-->
+
+ <div id="push"></div>
+ </div>
+ <!--/.wrapper -->
+
+ <footer class="span12">
+ <p>Sponsored by <a href="http://dabapps.com/">DabApps</a>.</a>
+ </p>
+ </footer>
+
+ <!-- Le javascript
+ ================================================== -->
+ <!-- Placed at the end of the document so the pages load faster -->
+ <script src="http://www.django-rest-framework.org/js/jquery-1.8.1-min.js"></script>
+ <script src="http://www.django-rest-framework.org/js/prettify-1.0.js"></script>
+ <script src="http://www.django-rest-framework.org/js/bootstrap-2.1.1-min.js"></script>
+ <script>
+ //$('.side-nav').scrollspy()
+ var shiftWindow = function() {
+ scrollBy(0, -50)
+ };
+ if (location.hash) shiftWindow();
+ window.addEventListener("hashchange", shiftWindow);
+
+ $('.dropdown-menu').on('click touchstart', function(event) {
+ event.stopPropagation();
+ });
+
+ // Dynamically force sidenav to no higher than browser window
+ $('.side-nav').css('max-height', window.innerHeight - 130);
+
+ $(function() {
+ $(window).resize(function() {
+ $('.side-nav').css('max-height', window.innerHeight - 130);
+ });
+ });
+ </script>
+</body>
+
+</html>
diff --git a/docs_theme/base.html b/docs_theme/base.html
new file mode 100644
index 00000000..6bfccab2
--- /dev/null
+++ b/docs_theme/base.html
@@ -0,0 +1,196 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <meta charset="utf-8">
+ <title>{{ page_title }}</title>
+ <link href="{{ base_url }}/img/favicon.ico" rel="icon" type="image/x-icon">
+ <link rel="canonical" href="{{ canonical_url }}" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <meta name="description" content="Django, API, REST, {{ current_page.title }}">
+ <meta name="author" content="Tom Christie">
+
+ <!-- Le styles -->
+ <link href="{{ base_url }}/css/prettify.css" rel="stylesheet">
+ <link href="{{ base_url }}/css/bootstrap.css" rel="stylesheet">
+ <link href="{{ base_url }}/css/bootstrap-responsive.css" rel="stylesheet">
+ <link href="{{ base_url }}/css/default.css" rel="stylesheet">
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-18852272-2']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script');
+ ga.type = 'text/javascript';
+ ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0];
+ s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+
+ <style>
+ span.fusion-wrap a {
+ display: block;
+ margin-top: 10px;
+ color: black;
+ }
+ a.fusion-poweredby {
+ display: block;
+ margin-top: 10px;
+ }
+ @media (max-width: 767px) {
+ div.promo {
+ display: none;
+ }
+ }
+ </style>
+</head>
+<body onload="prettyPrint()" class="{% if current_page.is_homepage %}index{% endif %}-page">
+
+ <div class="wrapper">
+
+ {% include "nav.html" %}
+
+ <div class="body-content">
+ <div class="container-fluid">
+
+ <!-- Search Modal -->
+ <div id="searchModal" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true">
+ <div class="modal-header">
+ <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
+ <h3 id="myModalLabel">Documentation search</h3>
+ </div>
+
+ <div class="modal-body">
+ <!-- Custom google search -->
+ <script>
+ (function() {
+ var cx = '015016005043623903336:rxraeohqk6w';
+ var gcse = document.createElement('script');
+ gcse.type = 'text/javascript';
+ gcse.async = true;
+ gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
+ '//www.google.com/cse/cse.js?cx=' + cx;
+ var s = document.getElementsByTagName('script')[0];
+ s.parentNode.insertBefore(gcse, s);
+ })();
+ </script>
+ <gcse:search></gcse:search>
+ </div>
+
+ <div class="modal-footer">
+ <button class="btn" data-dismiss="modal" aria-hidden="true">Close</button>
+ </div>
+ </div>
+
+ <div class="row-fluid">
+
+ <div class="span3">
+ <!-- TODO
+ <p style="margin-top: -12px">
+ <a class="btn btn-mini btn-primary" style="width: 60px">&laquo; previous</a>
+ <a class="btn btn-mini btn-primary" style="float: right; margin-right: 8px; width: 60px;">next &raquo;</a>
+ </p>
+ -->
+ <div id="table-of-contents">
+ <ul class="nav nav-list side-nav well sidebar-nav-fixed">
+
+ {% if current_page.is_homepage %}
+ <li class="main">
+ <a href="#">Django REST framework</a>
+ </li>
+ {% endif %}
+
+ {% for toc_item in toc %}
+
+ <li class="{% if not current_page.is_homepage %}main{% endif %}">
+ <a href="{{ toc_item.url }}">{{ toc_item.title }}</a>
+ </li>
+
+ {% for toc_item in toc_item.children %}
+ <li>
+ <a href="{{ toc_item.url }}">{{ toc_item.title }}</a>
+ </li>
+ {% endfor %}
+
+ {% endfor %}
+
+ {% if current_page.is_homepage %}
+ <div class="promo">
+ <hr/>
+ <script type="text/javascript" src="//cdn.fusionads.net/fusion.js?zoneid=1332&serve=C6SDP2Y&placement=djangorestframework" id="_fusionads_js"></script>
+ </div>
+ {% endif %}
+
+ </ul>
+
+ </div>
+ </div>
+
+ <div id="main-content" class="span9">
+ {% if meta.source %}
+ {% for filename in meta.source %}
+ <a class="github" href="https://github.com/tomchristie/django-rest-framework/tree/master/rest_framework/{{ filename }}">
+ <span class="label label-info">{{ filename }}</span>
+ </a>
+ {% endfor %}
+ {% endif %}
+
+ {{ content }}
+ </div>
+ <!--/span-->
+ </div>
+ <!--/row-->
+ </div>
+ <!--/.fluid-container-->
+ </div>
+ <!--/.body content-->
+ <div id="push"></div>
+ </div>
+ <!--/.wrapper -->
+
+ <footer class="span12">
+ <p>Sponsored by <a href="http://dabapps.com/">DabApps</a>.</a>
+ </p>
+ </footer>
+
+ <!-- Le javascript
+ ================================================== -->
+ <!-- Placed at the end of the document so the pages load faster -->
+ <script src="{{ base_url }}/js/jquery-1.8.1-min.js"></script>
+ <script src="{{ base_url }}/js/prettify-1.0.js"></script>
+ <script src="{{ base_url }}/js/bootstrap-2.1.1-min.js"></script>
+
+ <script>
+ //$('.side-nav').scrollspy()
+ var shiftWindow = function() {
+ scrollBy(0, -50)
+ };
+ if (location.hash) shiftWindow();
+ window.addEventListener("hashchange", shiftWindow);
+
+ $('.dropdown-menu').on('click touchstart', function(event) {
+ event.stopPropagation();
+ });
+
+ // Dynamically force sidenav to no higher than browser window
+ $('.side-nav').css('max-height', window.innerHeight - 130);
+
+ $(function() {
+ $(window).resize(function() {
+ $('.side-nav').css('max-height', window.innerHeight - 130);
+ });
+ });
+ </script>
+</body>
+
+</html>
diff --git a/docs_theme/nav.html b/docs_theme/nav.html
new file mode 100644
index 00000000..ca1afc0e
--- /dev/null
+++ b/docs_theme/nav.html
@@ -0,0 +1,47 @@
+ <div class="navbar navbar-inverse navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a class="repo-link btn btn-primary btn-small" href="https://github.com/tomchristie/django-rest-framework/tree/master">GitHub</a>
+ <a class="repo-link btn btn-inverse btn-small {% if not next_page %}disabled{% endif %}" rel="prev" {% if next_page %}href="{{ next_page.url }}"{% endif %}>
+ Next <i class="icon-arrow-right icon-white"></i>
+ </a>
+ <a class="repo-link btn btn-inverse btn-small {% if not previous_page %}disabled{% endif %}" rel="next" {% if previous_page %}href="{{ previous_page.url }}"{% endif %}>
+ <i class="icon-arrow-left icon-white"></i> Previous
+ </a>
+ <a class="repo-link btn btn-inverse btn-small" href="#searchModal" data-toggle="modal"><i class="icon-search icon-white"></i> Search</a>
+ <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+ <a class="brand" href="http://www.django-rest-framework.org">Django REST framework</a>
+ <div class="nav-collapse collapse">
+ {% if include_nav %}
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav">
+ <li {% if current_page.is_homepage %}class="active"{% endif %}><a href="/">Home</a></li>
+ {% for nav_item in nav %} {% if nav_item.children %}
+ <li class="dropdown{% if nav_item.active %} active{% endif %}">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">{{ nav_item.title }} <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ {% for nav_item in nav_item.children %}
+ <li {% if nav_item.active %}class="active" {% endif %}>
+ <a href="{{ nav_item.url }}">{{ nav_item.title }}</a>
+ </li>
+ {% endfor %}
+ </ul>
+ </li>
+ {% else %}
+ <li {% if nav_item.active %}class="active" {% endif %}>
+ <a href="{{ nav_item.url }}">{{ nav_item.title }}</a>
+ </li>
+ {% endif %} {% endfor %}
+
+ </ul>
+ {% endif %}
+ </div>
+ <!--/.nav-collapse -->
+
+ </div>
+ </div>
+ </div>
generated by cgit v1.2.3 (git 2.25.1) at 2025-11-02 19:22:44 +0000