Skip to content

D
django-rest-framework
Commit 330c1329 by Tom Christie
Options

Update documentation

parent 5769306c
Showing with 414 additions and 222 deletions
.DS_Store 0 → 100644
File added
css/base.css 0 → 100644
body {
padding-top: 70px;
background: url(../img/grid.png) repeat-x;
background-attachment: fixed;
background-color: #f8f8f8;
}
body > div.container {
min-height: 400px;
}
ul.nav li.main {
font-weight: bold;
}
div.col-md-3 {
padding-left: 0;
}
div.source-links {
float: right;
}
div.col-md-9 img {
max-width: 100%;
display: block;
padding: 4px;
line-height: 1.428571429;
background-color: #fff;
border: 1px solid #ddd;
border-radius: 4px;
margin: 20px auto 30px auto;
}
h1, h2, h3 {
color: #444;
}
h1 {
font-weight: 400;
font-size: 42px;
}
h2, h3, h4, h5, h6 {
font-weight: 300;
}
hr {
border-top: 1px solid #aaa;
}
pre, .rst-content tt {
max-width: 100%;
background: #fff;
border: solid 1px #e1e4e5;
color: #e74c3c;
overflow-x: auto;
}
code.code-large, .rst-content tt.code-large {
font-size: 90%;
}
code {
padding: 2px 5px;
color: #c7254e;
background-color: #f9f2f4;
font-size: 75%;
}
code, kbd, pre, samp {
font-family: monospace,serif;
font-size: 12px !important;
}
footer {
margin-top: 30px;
margin-bottom: 10px;
text-align: center;
font-weight: 200;
}
.modal-dialog {
margin-top: 60px;
}
/*
* Side navigation
*
* Scrollspy and affixed enhanced navigation to highlight sections and secondary
* sections of docs content.
*/
/* By default it's not affixed in mobile views, so undo that */
.bs-sidebar.affix {
position: static;
}
.bs-sidebar.well {
padding: 0;
}
/* First level of nav */
.bs-sidenav {
padding-top: 10px;
padding-bottom: 10px;
border-radius: 5px;
}
/* All levels of nav */
.bs-sidebar .nav > li > a {
display: block;
padding: 5px 20px;
}
.bs-sidebar .nav > li > a:hover,
.bs-sidebar .nav > li > a:focus {
text-decoration: none;
border-right: 1px solid;
}
.bs-sidebar .nav > .active > a,
.bs-sidebar .nav > .active:hover > a,
.bs-sidebar .nav > .active:focus > a {
font-weight: bold;
background-color: transparent;
border-right: 1px solid;
}
/* Nav: second level (shown on .active) */
.bs-sidebar .nav .nav {
display: none; /* Hide by default, but at >768px, show it */
margin-bottom: 8px;
}
.bs-sidebar .nav .nav > li > a {
padding-top: 3px;
padding-bottom: 3px;
padding-left: 30px;
font-size: 90%;
}
/* Show and affix the side nav when space allows it */
@media (min-width: 992px) {
.bs-sidebar .nav > .active > ul {
display: block;
}
/* Widen the fixed sidebar */
.bs-sidebar.affix,
.bs-sidebar.affix-bottom {
width: 213px;
}
.bs-sidebar.affix {
position: fixed; /* Undo the static from mobile first approach */
top: 80px;
}
.bs-sidebar.affix-bottom {
position: absolute; /* Undo the static from mobile first approach */
}
.bs-sidebar.affix-bottom .bs-sidenav,
.bs-sidebar.affix .bs-sidenav {
margin-top: 0;
margin-bottom: 0;
}
}
@media (min-width: 1200px) {
/* Widen the fixed sidebar again */
.bs-sidebar.affix-bottom,
.bs-sidebar.affix {
width: 263px;
}
}
\ No newline at end of file
css/bootstrap-custom.min.css 0 → 100644
This source diff could not be displayed because it is too large. You can view the blob instead.
css/bootstrap-responsive.css 100755 → 100644
File mode changed from 100755 to 100644
css/bootstrap.css 100755 → 100644
File mode changed from 100755 to 100644
css/default.css
......@@ -181,7 +181,7 @@ body{
}
.navbar .navbar-inner .nav li, .navbar .navbar-inner .nav li a, .navbar .navbar-inner .brand{
color: white;
color: white;
}
.nav-list > .active > a, .navbar .navbar-inner .nav li a:hover {
......@@ -190,8 +190,20 @@ body{
}
.navbar .navbar-inner .dropdown-menu li a, .navbar .navbar-inner .dropdown-menu li{
color: #A30000;
color: #A30000;
}
.dropdown-menu .active > a,
.dropdown-menu .active > a:hover {
background-image: none;
}
.navbar-inverse .nav .dropdown .active > a,
.navbar-inverse .nav .dropdown .active > a:hover,
.navbar-inverse .nav .dropdown .active > a:focus {
background-color: #eeeeee;
}
.navbar .navbar-inner .dropdown-menu li a:hover{
background: #eeeeee;
color: #c20000;
......
css/highlight.css 0 → 100644
/*
This is the GitHub theme for highlight.js
github.com style (c) Vasily Polovnyov <vast@whiteants.net>
*/
.hljs {
display: block; padding: 0.5em;
color: #333;
}
.hljs-comment,
.hljs-template_comment,
.diff .hljs-header,
.hljs-javadoc {
color: #998;
font-style: italic
}
.hljs-keyword,
.css .rule .hljs-keyword,
.hljs-winutils,
.javascript .hljs-title,
.nginx .hljs-title,
.hljs-subst,
.hljs-request,
.hljs-status {
color: #333;
font-weight: bold
}
.hljs-number,
.hljs-hexcolor,
.ruby .hljs-constant {
color: #099;
}
.hljs-string,
.hljs-tag .hljs-value,
.hljs-phpdoc,
.tex .hljs-formula {
color: #d14
}
.hljs-title,
.hljs-id,
.coffeescript .hljs-params,
.scss .hljs-preprocessor {
color: #900;
font-weight: bold
}
.javascript .hljs-title,
.lisp .hljs-title,
.clojure .hljs-title,
.hljs-subst {
font-weight: normal
}
.hljs-class .hljs-title,
.haskell .hljs-type,
.vhdl .hljs-literal,
.tex .hljs-command {
color: #458;
font-weight: bold
}
.hljs-tag,
.hljs-tag .hljs-title,
.hljs-rules .hljs-property,
.django .hljs-tag .hljs-keyword {
color: #000080;
font-weight: normal
}
.hljs-attribute,
.hljs-variable,
.lisp .hljs-body {
color: #008080
}
.hljs-regexp {
color: #009926
}
.hljs-symbol,
.ruby .hljs-symbol .hljs-string,
.lisp .hljs-keyword,
.tex .hljs-special,
.hljs-prompt {
color: #990073
}
.hljs-built_in,
.lisp .hljs-title,
.clojure .hljs-built_in {
color: #0086b3
}
.hljs-preprocessor,
.hljs-pragma,
.hljs-pi,
.hljs-doctype,
.hljs-shebang,
.hljs-cdata {
color: #999;
font-weight: bold
}
.hljs-deletion {
background: #fdd
}
.hljs-addition {
background: #dfd
}
.diff .hljs-change {
background: #0086b3
}
.hljs-chunk {
color: #aaa
}
css/prettify-1.0.css 0 → 100644
.com { color: #93a1a1; }
.lit { color: #195f91; }
.pun, .opn, .clo { color: #93a1a1; }
.fun { color: #dc322f; }
.str, .atv { color: #D14; }
.kwd, .prettyprint .tag { color: #1e347b; }
.typ, .atn, .dec, .var { color: teal; }
.pln { color: #48484c; }
.prettyprint {
padding: 8px;
}
.prettyprint.linenums {
-webkit-box-shadow: inset 40px 0 0 #fbfbfc, inset 41px 0 0 #ececf0;
-moz-box-shadow: inset 40px 0 0 #fbfbfc, inset 41px 0 0 #ececf0;
box-shadow: inset 40px 0 0 #fbfbfc, inset 41px 0 0 #ececf0;
}
/* Specify class=linenums on a pre to get line numbering */
ol.linenums {
margin: 0 0 0 33px; /* IE indents via margin-left */
}
ol.linenums li {
padding-left: 12px;
color: #bebec5;
line-height: 20px;
text-shadow: 0 1px 0 #fff;
}
fonts/fontawesome-webfont.svg 0 → 100644
This source diff could not be displayed because it is too large. You can view the blob instead.
img/.DS_Store 0 → 100644
File added
js/base.js 0 → 100644
/* Highlight */
$( document ).ready(function() {
hljs.initHighlightingOnLoad();
$('table').addClass('table');
});
/* Scrollspy */
var navHeight = $('.navbar').outerHeight(true) + 10
$('body').scrollspy({
target: '.bs-sidebar',
offset: navHeight
})
/* Prevent disabled links from causing a page reload */
$("li.disabled a").click(function() {
event.preventDefault();
});
/* Adjust the scroll height of anchors to compensate for the fixed navbar */
window.disableShift = false;
var shiftWindow = function() {
if (window.disableShift) {
window.disableShift = false;
} else {
/* If we're at the bottom of the page, don't erronously scroll up */
var scrolledToBottomOfPage = (
(window.innerHeight + window.scrollY) >= document.body.offsetHeight
);
if (!scrolledToBottomOfPage) {
scrollBy(0, -60);
};
};
};
if (location.hash) {shiftWindow();}
window.addEventListener("hashchange", shiftWindow);
/* Deal with clicks on nav links that do not change the current anchor link. */
$("ul.nav a" ).click(function() {
var href = this.href;
var suffix = location.hash;
var matchesCurrentHash = (href.indexOf(suffix, href.length - suffix.length) !== -1);
if (location.hash && matchesCurrentHash) {
/* Force a single 'hashchange' event to occur after the click event */
window.disableShift = true;
location.hash='';
};
});
js/bootstrap-2.1.1-min.js 100755 → 100644
File mode changed from 100755 to 100644
license/highlight.js/LICENSE 0 → 100644
Copyright (c) 2006, Ivan Sagalaev
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of highlight.js nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
robots.txt deleted 100644 → 0
User-agent: *
Disallow:
sitemap.xml deleted 100644 → 0
<?xml version="1.0" encoding="UTF-8"?>
<urlset
xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9
http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">
<url>
<loc>http://www.django-rest-framework.org/</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/tutorial/quickstart</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>monthly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/tutorial/1-serialization</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>monthly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/tutorial/2-requests-and-responses</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>monthly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/tutorial/3-class-based-views</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>monthly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/tutorial/4-authentication-and-permissions</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>monthly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/tutorial/5-relationships-and-hyperlinked-apis</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>monthly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/tutorial/6-viewsets-and-routers</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>monthly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/requests</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/responses</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/views</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/generic-views</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/viewsets</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/routers</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/parsers</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/renderers</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/serializers</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/fields</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/relations</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/authentication</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/permissions</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/throttling</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/filtering</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/pagination</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/content-negotiation</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/format-suffixes</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/reverse</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/exceptions</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/status-codes</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/testing</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/api-guide/settings</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/topics/documenting-your-api</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/topics/ajax-csrf-cors</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/topics/browser-enhancements</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/topics/browsable-api</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/topics/rest-hypermedia-hateoas</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/topics/contributing</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/topics/rest-framework-2-announcement</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>monthly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/topics/2.2-announcement</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>monthly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/topics/2.3-announcement</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>monthly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/topics/release-notes</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org/topics/credits</loc>
<lastmod>2014-01-02T09:29:15+00:00</lastmod>
<changefreq>weekly</changefreq>
</url>
</urlset>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment