encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-14 05:36:50 +03:00
Code Issues Packages Projects Releases Wiki Activity
da89cfc937
django-rest-framework/docs/template.html

222 lines
11 KiB
HTML
Raw Normal View History

REST framework 2 docs
2012-09-01 23:26:27 +04:00
<!DOCTYPE html>
Add analytics
2012-10-26 12:30:46 +04:00
<html lang="en">
<head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
REST framework 2 docs
2012-09-01 23:26:27 +04:00
<meta charset="utf-8">
Better titles & descriptions
2013-03-15 17:41:22 +04:00
<title>{{ title }}</title>
Add favicon to docs
2012-10-05 18:26:15 +04:00
<link href="{{ base_url }}/img/favicon.ico" rel="icon" type="image/x-icon">
Drop .html suffixes in docs
2013-11-18 20:10:14 +04:00
<link rel="canonical" href="{{ canonical_url }}"/>
REST framework 2 docs
2012-09-01 23:26:27 +04:00
<meta name="viewport" content="width=device-width, initial-scale=1.0">
Better titles & descriptions
2013-03-15 17:41:22 +04:00
<meta name="description" content="{{ description }}">
<meta name="author" content="Tom Christie">
REST framework 2 docs
2012-09-01 23:26:27 +04:00
<!-- Le styles -->
Code highlighting in docs
2012-09-08 23:23:32 +04:00
<link href="{{ base_url }}/css/prettify.css" rel="stylesheet">
REST framework 2 docs
2012-09-01 23:26:27 +04:00
<link href="{{ base_url }}/css/bootstrap.css" rel="stylesheet">
<link href="{{ base_url }}/css/bootstrap-responsive.css" rel="stylesheet">
Tweaks to Token auth
2012-09-12 23:39:22 +04:00
<link href="{{ base_url }}/css/default.css" rel="stylesheet">
REST framework 2 docs
2012-09-01 23:26:27 +04:00
<!-- 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]-->
Add analytics
2012-10-26 12:30:46 +04:00
<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>
Pagination docs
2012-10-01 19:17:01 +04:00
<body onload="prettyPrint()" class="{{ page_id }}-page">
REST framework 2 docs
2012-09-01 23:26:27 +04:00
Added sticky footer to docs
2012-10-05 19:32:41 +04:00
<div class="wrapper">
REST framework 2 docs
2012-09-01 23:26:27 +04:00
<div class="navbar navbar-inverse navbar-fixed-top">
<div class="navbar-inner">
<div class="container-fluid">
Make docs ready to push to django-rest-framework.org
2012-10-30 18:18:16 +04:00
<a class="repo-link btn btn-primary btn-small" href="https://github.com/tomchristie/django-rest-framework/tree/master">GitHub</a>
Add search and next/prev
2013-03-28 19:58:53 +04:00
<a class="repo-link btn btn-inverse btn-small {{ next_url_disabled }}" href="{{ next_url }}">Next <i class="icon-arrow-right icon-white"></i></a>
<a class="repo-link btn btn-inverse btn-small {{ prev_url_disabled }}" href="{{ prev_url }}"><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>
REST framework 2 docs
2012-09-01 23:26:27 +04:00
<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="{{ base_url }}{{ index }}">Django REST framework</a>
<div class="nav-collapse collapse">
<ul class="nav">
<li><a href="{{ base_url }}{{ index }}">Home</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Tutorial <b class="caret"></b></a>
<ul class="dropdown-menu">
Relational field support in browseable API. Add slug relational fields. Add quickstart.
2012-11-02 03:04:13 +04:00
<li><a href="{{ base_url }}/tutorial/quickstart{{ suffix }}">Quickstart</a></li>
REST framework 2 docs
2012-09-01 23:26:27 +04:00
<li><a href="{{ base_url }}/tutorial/1-serialization{{ suffix }}">1 - Serialization</a></li>
<li><a href="{{ base_url }}/tutorial/2-requests-and-responses{{ suffix }}">2 - Requests and responses</a></li>
<li><a href="{{ base_url }}/tutorial/3-class-based-views{{ suffix }}">3 - Class based views</a></li>
Minor fixes
2012-10-28 23:37:27 +04:00
<li><a href="{{ base_url }}/tutorial/4-authentication-and-permissions{{ suffix }}">4 - Authentication and permissions</a></li>
REST framework 2 docs
2012-09-01 23:26:27 +04:00
<li><a href="{{ base_url }}/tutorial/5-relationships-and-hyperlinked-apis{{ suffix }}">5 - Relationships and hyperlinked APIs</a></li>
Viewsets and routers in seperate docs
2013-04-09 14:54:51 +04:00
<li><a href="{{ base_url }}/tutorial/6-viewsets-and-routers{{ suffix }}">6 - Viewsets and routers</a></li>
REST framework 2 docs
2012-09-01 23:26:27 +04:00
</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="{{ base_url }}/api-guide/requests{{ suffix }}">Requests</a></li>
<li><a href="{{ base_url }}/api-guide/responses{{ suffix }}">Responses</a></li>
<li><a href="{{ base_url }}/api-guide/views{{ suffix }}">Views</a></li>
Updating docs
2012-09-12 13:12:13 +04:00
<li><a href="{{ base_url }}/api-guide/generic-views{{ suffix }}">Generic views</a></li>
Viewsets and routers in seperate docs
2013-04-09 14:54:51 +04:00
<li><a href="{{ base_url }}/api-guide/viewsets{{ suffix }}">Viewsets</a></li>
<li><a href="{{ base_url }}/api-guide/routers{{ suffix }}">Routers</a></li>
REST framework 2 docs
2012-09-01 23:26:27 +04:00
<li><a href="{{ base_url }}/api-guide/parsers{{ suffix }}">Parsers</a></li>
<li><a href="{{ base_url }}/api-guide/renderers{{ suffix }}">Renderers</a></li>
<li><a href="{{ base_url }}/api-guide/serializers{{ suffix }}">Serializers</a></li>
Add serializer fields documentation
2012-10-05 20:10:07 +04:00
<li><a href="{{ base_url }}/api-guide/fields{{ suffix }}">Serializer fields</a></li>
Relation fields move into relations.py
2012-12-31 12:53:40 +04:00
<li><a href="{{ base_url }}/api-guide/relations{{ suffix }}">Serializer relations</a></li>
REST framework 2 docs
2012-09-01 23:26:27 +04:00
<li><a href="{{ base_url }}/api-guide/authentication{{ suffix }}">Authentication</a></li>
<li><a href="{{ base_url }}/api-guide/permissions{{ suffix }}">Permissions</a></li>
<li><a href="{{ base_url }}/api-guide/throttling{{ suffix }}">Throttling</a></li>
Add filtering into documentation
2012-11-08 01:28:10 +04:00
<li><a href="{{ base_url }}/api-guide/filtering{{ suffix }}">Filtering</a></li>
Pagination docs
2012-10-01 19:17:01 +04:00
<li><a href="{{ base_url }}/api-guide/pagination{{ suffix }}">Pagination</a></li>
Updating docs
2012-09-12 13:12:13 +04:00
<li><a href="{{ base_url }}/api-guide/content-negotiation{{ suffix }}">Content negotiation</a></li>
<li><a href="{{ base_url }}/api-guide/format-suffixes{{ suffix }}">Format suffixes</a></li>
<li><a href="{{ base_url }}/api-guide/reverse{{ suffix }}">Returning URLs</a></li>
REST framework 2 docs
2012-09-01 23:26:27 +04:00
<li><a href="{{ base_url }}/api-guide/exceptions{{ suffix }}">Exceptions</a></li>
<li><a href="{{ base_url }}/api-guide/status-codes{{ suffix }}">Status codes</a></li>
Update docs to include testing.
2013-08-16 17:12:24 +04:00
<li><a href="{{ base_url }}/api-guide/testing{{ suffix }}">Testing</a></li>
Add missing doc files
2012-09-05 13:01:43 +04:00
<li><a href="{{ base_url }}/api-guide/settings{{ suffix }}">Settings</a></li>
REST framework 2 docs
2012-09-01 23:26:27 +04:00
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Topics <b class="caret"></b></a>
<ul class="dropdown-menu">
Added 'Documenting your API' section. Closes #616
2013-07-03 01:15:46 +04:00
<li><a href="{{ base_url }}/topics/documenting-your-api{{ suffix }}">Documenting your API</a></li>
AJAX, CSRF & CORS documentation
2013-01-27 21:23:56 +04:00
<li><a href="{{ base_url }}/topics/ajax-csrf-cors{{ suffix }}">AJAX, CSRF & CORS</a></li>
Improve documentation for Requests
2012-10-13 18:07:43 +04:00
<li><a href="{{ base_url }}/topics/browser-enhancements{{ suffix }}">Browser enhancements</a></li>
Docs tweaks
2012-10-13 18:34:38 +04:00
<li><a href="{{ base_url }}/topics/browsable-api{{ suffix }}">The Browsable API</a></li>
Adding migration and changelog docs
2012-10-08 15:17:43 +04:00
<li><a href="{{ base_url }}/topics/rest-hypermedia-hateoas{{ suffix }}">REST, Hypermedia & HATEOAS</a></li>
First pass on contribution guide
2013-12-04 18:59:09 +04:00
<li><a href="{{ base_url }}/topics/contributing{{ suffix }}">Contributing to REST framework</a></li>
2.0 Announcement
2012-10-27 21:39:17 +04:00
<li><a href="{{ base_url }}/topics/rest-framework-2-announcement{{ suffix }}">2.0 Announcement</a></li>
Add links to 2.2 announcement
2013-02-13 18:08:56 +04:00
<li><a href="{{ base_url }}/topics/2.2-announcement{{ suffix }}">2.2 Announcement</a></li>
Docs, docs, docs
2013-04-25 23:43:37 +04:00
<li><a href="{{ base_url }}/topics/2.3-announcement{{ suffix }}">2.3 Announcement</a></li>
Docs tweaks
2012-10-17 16:51:15 +04:00
<li><a href="{{ base_url }}/topics/release-notes{{ suffix }}">Release Notes</a></li>
Docs tweak for first docs deployment
2012-09-02 00:35:30 +04:00
<li><a href="{{ base_url }}/topics/credits{{ suffix }}">Credits</a></li>
REST framework 2 docs
2012-09-01 23:26:27 +04:00
</ul>
</li>
</ul>
<ul class="nav pull-right">
Tweak static files with docs
2012-10-09 17:12:38 +04:00
<!-- TODO
[docs] Move styles to own file. Fix table-of-contents positioning when viewed on <767px screens. The fixed positioning of the ToC needs to be overridden with static, so that the ToC falls back into the flow of content and is sized correctly. Also, this prevents the actual page content from riding up behind the ToC and being obscured.
2012-09-07 21:05:44 +04:00
<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>
Tweak static files with docs
2012-10-09 17:12:38 +04:00
-->
[docs] Move styles to own file. Fix table-of-contents positioning when viewed on <767px screens. The fixed positioning of the ToC needs to be overridden with static, so that the ToC falls back into the flow of content and is sized correctly. Also, this prevents the actual page content from riding up behind the ToC and being obscured.
2012-09-07 21:05:44 +04:00
</ul>
REST framework 2 docs
2012-09-01 23:26:27 +04:00
</div><!--/.nav-collapse -->
</div>
</div>
</div>
Added sticky footer to docs
2012-10-05 19:32:41 +04:00
<div class="body-content">
<div class="container-fluid">
Add search and next/prev
2013-03-28 19:58:53 +04:00
<!-- 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>
Added sticky footer to docs
2012-10-05 19:32:41 +04:00
<div class="row-fluid">
Added dabapps styles and general improvements to docs
2012-10-05 15:29:53 +04:00
Added sticky footer to docs
2012-10-05 19:32:41 +04:00
<div class="span3">
Adding migration and changelog docs
2012-10-08 15:17:43 +04:00
<!-- 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>
-->
Added sticky footer to docs
2012-10-05 19:32:41 +04:00
<div id="table-of-contents">
<ul class="nav nav-list side-nav well sidebar-nav-fixed">
{{ toc }}
Add invite signup
2013-10-21 12:30:01 +04:00
<div>
Link to BrightAPI, and remove ad except from frontpage
2014-01-03 17:24:52 +04:00
{{ ad_block }}
</div>
</ul>
Add invite signup
2013-10-21 12:30:01 +04:00
Added sticky footer to docs
2012-10-05 19:32:41 +04:00
</div>
[docs] Move styles to own file. Fix table-of-contents positioning when viewed on <767px screens. The fixed positioning of the ToC needs to be overridden with static, so that the ToC falls back into the flow of content and is sized correctly. Also, this prevents the actual page content from riding up behind the ToC and being obscured.
2012-09-07 21:05:44 +04:00
</div>
REST framework 2 docs
2012-09-01 23:26:27 +04:00
Added sticky footer to docs
2012-10-05 19:32:41 +04:00
<div id="main-content" class="span9">
{{ content }}
</div><!--/span-->
</div><!--/row-->
</div><!--/.fluid-container-->
</div><!--/.body content-->
REST framework 2 docs
2012-09-01 23:26:27 +04:00
Doc style tweaks
2012-10-05 18:22:30 +04:00
<div id="push"></div>
Added sticky footer to docs
2012-10-05 19:32:41 +04:00
</div><!--/.wrapper -->
Doc style tweaks
2012-10-05 18:22:30 +04:00
Added sticky footer to docs
2012-10-05 19:32:41 +04:00
<footer class="span12">
DabApps, not Dab Apps
2012-10-05 22:33:13 +04:00
<p>Sponsored by <a href="http://dabapps.com/">DabApps</a>.</a></p>
Added sticky footer to docs
2012-10-05 19:32:41 +04:00
</footer>
Doc style tweaks
2012-10-05 18:22:30 +04:00
REST framework 2 docs
2012-09-01 23:26:27 +04:00
<!-- Le javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
[docs] Update jQuery to 1.8.1
2012-09-07 22:12:29 +04:00
<script src="{{ base_url }}/js/jquery-1.8.1-min.js"></script>
Added JS version numbers
2012-10-05 15:43:35 +04:00
<script src="{{ base_url }}/js/prettify-1.0.js"></script>
<script src="{{ base_url }}/js/bootstrap-2.1.1-min.js"></script>
REST framework 2 docs
2012-09-01 23:26:27 +04:00
<script>
[docs] Add bootstrap-collapse plugin, fixing collapsing navbar.
2012-09-07 21:01:30 +04:00
//$('.side-nav').scrollspy()
var shiftWindow = function() { scrollBy(0, -50) };
if (location.hash) shiftWindow();
window.addEventListener("hashchange", shiftWindow);
Updating docs
2012-09-12 13:12:13 +04:00
Prevent the touchstart event propagation on the dropdown menus in the navbar. This allows the dropdowns to be used on a touch device.
2012-09-17 18:01:44 +04:00
$('.dropdown-menu').on('click touchstart', function(event) {
Updating docs
2012-09-12 13:12:13 +04:00
event.stopPropagation();
});
Fix sidebar styling when browser window is too small
2013-06-27 02:26:35 +04:00
// Dynamically force sidenav to no higher than browser window
Tweak styling for max-height of sidenav
2013-06-27 15:58:38 +04:00
$('.side-nav').css('max-height', window.innerHeight - 130);
Fix sidebar styling when browser window is too small
2013-06-27 02:26:35 +04:00
$(function(){
$(window).resize(function(){
Tweak styling for max-height of sidenav
2013-06-27 15:58:38 +04:00
$('.side-nav').css('max-height', window.innerHeight - 130);
Fix sidebar styling when browser window is too small
2013-06-27 02:26:35 +04:00
});
});
REST framework 2 docs
2012-09-01 23:26:27 +04:00
</script>
Pagination docs
2012-10-01 19:17:01 +04:00
</body></html>
Reference in New Issue Copy Permalink