encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-29 13:04:03 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2849 from d0ugal/master

Browse Source 
Migrate from Google search to MkDocs.
This commit is contained in:
Tom Christie 2015-06-01 09:31:44 +01:00
commit a0f66ffc69
7 changed files with 122 additions and 293 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

215
docs_theme/404.html
View File

@ -1,216 +1,9 @@
<!DOCTYPE html> {% extends "base.html" %}
<html lang="en">
<head> {% block content %}
<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> <h1 id="404-page-not-found" style="text-align: center">404</h1>
<p style="text-align: center"><strong>Page not found</strong> <p style="text-align: center"><strong>Page not found</strong></p>
</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> <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> {% endblock %}
</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>

42
docs_theme/base.html
View File

@ -4,11 +4,11 @@
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="utf-8"> <meta charset="utf-8">
<title>{{ page_title }}</title> <title>{% if page_title %}{{ page_title }} - {% endif %}{{ site_name }}</title>
<link href="{{ base_url }}/img/favicon.ico" rel="icon" type="image/x-icon"> <link href="{{ base_url }}/img/favicon.ico" rel="icon" type="image/x-icon">
<link rel="canonical" href="{{ canonical_url }}" /> <link rel="canonical" href="{{ canonical_url }}" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="Django, API, REST, {{ current_page.title }}"> <meta name="description" content="Django, API, REST{% if current_page %}, {{ current_page.title }}{% endif %}">
<meta name="author" content="Tom Christie"> <meta name="author" content="Tom Christie">
<!-- Le styles --> <!-- Le styles -->
@ -54,7 +54,7 @@
} }
</style> </style>
</head> </head>
<body onload="prettyPrint()" class="{% if current_page.is_homepage %}index{% endif %}-page"> <body onload="prettyPrint()" class="{% if current_page and current_page.is_homepage %}index{% endif %}-page">
<div class="wrapper"> <div class="wrapper">
@ -64,27 +64,19 @@
<div class="container-fluid"> <div class="container-fluid">
<!-- Search Modal --> <!-- Search Modal -->
<div id="searchModal" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true"> <div id="mkdocs_search_modal" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true">
<div class="modal-header"> <div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button> <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
<h3 id="myModalLabel">Documentation search</h3> <h3 id="myModalLabel">Documentation search</h3>
</div> </div>
<div class="modal-body"> <div class="modal-body">
<!-- Custom google search --> <form role="form">
<script> <div class="form-group">
(function() { <input type="text" name="q" class="form-control" placeholder="Search..." id="mkdocs-search-query">
var cx = '015016005043623903336:rxraeohqk6w'; </div>
var gcse = document.createElement('script'); </form>
gcse.type = 'text/javascript'; <div id="mkdocs-search-results"></div>
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>
<div class="modal-footer"> <div class="modal-footer">
@ -104,7 +96,7 @@
<div id="table-of-contents"> <div id="table-of-contents">
<ul class="nav nav-list side-nav well sidebar-nav-fixed"> <ul class="nav nav-list side-nav well sidebar-nav-fixed">
{% if current_page.is_homepage %} {% if current_page and current_page.is_homepage %}
<li class="main"> <li class="main">
<a href="#">Django REST framework</a> <a href="#">Django REST framework</a>
</li> </li>
@ -112,7 +104,7 @@
{% for toc_item in toc %} {% for toc_item in toc %}
<li class="{% if not current_page.is_homepage %}main{% endif %}"> <li class="{% if current_page and not current_page.is_homepage %}main{% endif %}">
<a href="{{ toc_item.url }}">{{ toc_item.title }}</a> <a href="{{ toc_item.url }}">{{ toc_item.title }}</a>
</li> </li>
@ -124,7 +116,7 @@
{% endfor %} {% endfor %}
{% if current_page.is_homepage %} {% if current_page and current_page.is_homepage %}
<div class="promo"> <div class="promo">
<hr/> <hr/>
<script type="text/javascript" src="//cdn.fusionads.net/fusion.js?zoneid=1332&serve=C6SDP2Y&placement=djangorestframework" id="_fusionads_js"></script> <script type="text/javascript" src="//cdn.fusionads.net/fusion.js?zoneid=1332&serve=C6SDP2Y&placement=djangorestframework" id="_fusionads_js"></script>
@ -137,6 +129,9 @@
</div> </div>
<div id="main-content" class="span9"> <div id="main-content" class="span9">
{% block content %}
{% if meta.source %} {% if meta.source %}
{% for filename in meta.source %} {% for filename in meta.source %}
<a class="github" href="https://github.com/tomchristie/django-rest-framework/tree/master/rest_framework/{{ filename }}"> <a class="github" href="https://github.com/tomchristie/django-rest-framework/tree/master/rest_framework/{{ filename }}">
@ -146,6 +141,9 @@
{% endif %} {% endif %}
{{ content }} {{ content }}
{% endblock %}
</div> </div>
<!--/span--> <!--/span-->
</div> </div>
@ -169,6 +167,8 @@
<script src="{{ base_url }}/js/jquery-1.8.1-min.js"></script> <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/prettify-1.0.js"></script>
<script src="{{ base_url }}/js/bootstrap-2.1.1-min.js"></script> <script src="{{ base_url }}/js/bootstrap-2.1.1-min.js"></script>
<script>var base_url = '{{ base_url }}';</script>
<script src="{{ base_url }}/mkdocs/js/require.js"></script>
<script src="{{ base_url }}/js/theme.js"></script> <script src="{{ base_url }}/js/theme.js"></script>
<script> <script>

4
docs_theme/css/default.css
View File

@ -415,3 +415,7 @@ ul.sponsor {
list-style: none; list-style: none;
display: block; display: block;
} }
#mkdocs_search_modal article p{
word-wrap: break-word;
}

32
docs_theme/js/theme.js
View File

@ -1,5 +1,35 @@
$(function(){ function getSearchTerm()
{
var sPageURL = window.location.search.substring(1);
var sURLVariables = sPageURL.split('&');
for (var i = 0; i < sURLVariables.length; i++)
{
var sParameterName = sURLVariables[i].split('=');
if (sParameterName[0] == 'q')
{
return sParameterName[1];
}
}
}
$(function() {
var initialise_search = function(){
require.config({"baseUrl":"/mkdocs/js"});
require(["search",]);
}
var search_term = getSearchTerm();
if(search_term){
$('#mkdocs_search_modal').modal();
}
$('pre code').parent().addClass('prettyprint well'); $('pre code').parent().addClass('prettyprint well');
$(document).on("submit", "#mkdocs_search_modal form", function (e) {
$("#mkdocs-search-results").html("Searching...");
initialise_search();
return false;
});
}); });

3
docs_theme/nav.html
View File

@ -8,7 +8,7 @@
<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 %}> <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 <i class="icon-arrow-left icon-white"></i> Previous
</a> </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 id="search_modal_show" class="repo-link btn btn-inverse btn-small" href="#mkdocs_search_modal" data-toggle="modal" data-target="#mkdocs_search_modal"><i class="icon-search icon-white"></i> Search</a>
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"> <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> <span class="icon-bar"></span>
@ -19,7 +19,6 @@
{% if include_nav %} {% if include_nav %}
<!-- Main navigation --> <!-- Main navigation -->
<ul class="nav navbar-nav"> <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 %} {% for nav_item in nav %} {% if nav_item.children %}
<li class="dropdown{% if nav_item.active %} active{% endif %}"> <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> <a href="#" class="dropdown-toggle" data-toggle="dropdown">{{ nav_item.title }} <b class="caret"></b></a>

97
mkdocs.yml
View File

@ -7,50 +7,53 @@ repo_url: https://github.com/tomchristie/django-rest-framework
theme_dir: docs_theme theme_dir: docs_theme
pages: pages:
- ['index.md', 'Home'] - Home: 'index.md'
- ['tutorial/quickstart.md', 'Tutorial', 'Quickstart'] - Tutorial:
- ['tutorial/1-serialization.md', 'Tutorial', '1 - Serialization'] - 'Quickstart': 'tutorial/quickstart.md'
- ['tutorial/2-requests-and-responses.md', 'Tutorial', '2 - Requests and responses'] - '1 - Serialization': 'tutorial/1-serialization.md'
- ['tutorial/3-class-based-views.md', 'Tutorial', '3 - Class based views'] - '2 - Requests and responses': 'tutorial/2-requests-and-responses.md'
- ['tutorial/4-authentication-and-permissions.md', 'Tutorial', '4 - Authentication and permissions'] - '3 - Class based views': 'tutorial/3-class-based-views.md'
- ['tutorial/5-relationships-and-hyperlinked-apis.md', 'Tutorial', '5 - Relationships and hyperlinked APIs'] - '4 - Authentication and permissions': 'tutorial/4-authentication-and-permissions.md'
- ['tutorial/6-viewsets-and-routers.md', 'Tutorial', '6 - Viewsets and routers'] - '5 - Relationships and hyperlinked APIs': 'tutorial/5-relationships-and-hyperlinked-apis.md'
- ['api-guide/requests.md', 'API Guide', 'Requests'] - '6 - Viewsets and routers': 'tutorial/6-viewsets-and-routers.md'
- ['api-guide/responses.md', 'API Guide', 'Responses'] - API Guide:
- ['api-guide/views.md', 'API Guide', 'Views'] - 'Requests': 'api-guide/requests.md'
- ['api-guide/generic-views.md', 'API Guide', 'Generic views'] - 'Responses': 'api-guide/responses.md'
- ['api-guide/viewsets.md', 'API Guide', 'Viewsets'] - 'Views': 'api-guide/views.md'
- ['api-guide/routers.md', 'API Guide', 'Routers'] - 'Generic views': 'api-guide/generic-views.md'
- ['api-guide/parsers.md', 'API Guide', 'Parsers'] - 'Viewsets': 'api-guide/viewsets.md'
- ['api-guide/renderers.md', 'API Guide', 'Renderers'] - 'Routers': 'api-guide/routers.md'
- ['api-guide/serializers.md', 'API Guide', 'Serializers'] - 'Parsers': 'api-guide/parsers.md'
- ['api-guide/fields.md', 'API Guide', 'Serializer fields'] - 'Renderers': 'api-guide/renderers.md'
- ['api-guide/relations.md', 'API Guide', 'Serializer relations'] - 'Serializers': 'api-guide/serializers.md'
- ['api-guide/validators.md', 'API Guide', 'Validators'] - 'Serializer fields': 'api-guide/fields.md'
- ['api-guide/authentication.md', 'API Guide', 'Authentication'] - 'Serializer relations': 'api-guide/relations.md'
- ['api-guide/permissions.md', 'API Guide', 'Permissions'] - 'Validators': 'api-guide/validators.md'
- ['api-guide/throttling.md', 'API Guide', 'Throttling'] - 'Authentication': 'api-guide/authentication.md'
- ['api-guide/filtering.md', 'API Guide', 'Filtering'] - 'Permissions': 'api-guide/permissions.md'
- ['api-guide/pagination.md', 'API Guide', 'Pagination'] - 'Throttling': 'api-guide/throttling.md'
- ['api-guide/versioning.md', 'API Guide', 'Versioning'] - 'Filtering': 'api-guide/filtering.md'
- ['api-guide/content-negotiation.md', 'API Guide', 'Content negotiation'] - 'Pagination': 'api-guide/pagination.md'
- ['api-guide/metadata.md', 'API Guide', 'Metadata'] - 'Versioning': 'api-guide/versioning.md'
- ['api-guide/format-suffixes.md', 'API Guide', 'Format suffixes'] - 'Content negotiation': 'api-guide/content-negotiation.md'
- ['api-guide/reverse.md', 'API Guide', 'Returning URLs'] - 'Metadata': 'api-guide/metadata.md'
- ['api-guide/exceptions.md', 'API Guide', 'Exceptions'] - 'Format suffixes': 'api-guide/format-suffixes.md'
- ['api-guide/status-codes.md', 'API Guide', 'Status codes'] - 'Returning URLs': 'api-guide/reverse.md'
- ['api-guide/testing.md', 'API Guide', 'Testing'] - 'Exceptions': 'api-guide/exceptions.md'
- ['api-guide/settings.md', 'API Guide', 'Settings'] - 'Status codes': 'api-guide/status-codes.md'
- ['topics/documenting-your-api.md', 'Topics', 'Documenting your API'] - 'Testing': 'api-guide/testing.md'
- ['topics/internationalization.md', 'Topics', 'Internationalization'] - 'Settings': 'api-guide/settings.md'
- ['topics/ajax-csrf-cors.md', 'Topics', 'AJAX, CSRF & CORS'] - Topics:
- ['topics/browser-enhancements.md', 'Topics',] - 'Documenting your API': 'topics/documenting-your-api.md'
- ['topics/browsable-api.md', 'Topics', 'The Browsable API'] - 'Internationalization': 'topics/internationalization.md'
- ['topics/rest-hypermedia-hateoas.md', 'Topics', 'REST, Hypermedia & HATEOAS'] - 'AJAX, CSRF & CORS': 'topics/ajax-csrf-cors.md'
- ['topics/third-party-resources.md', 'Topics', 'Third Party Resources'] - 'Browser Enhancements': 'topics/browser-enhancements.md'
- ['topics/contributing.md', 'Topics', 'Contributing to REST framework'] - 'The Browsable API': 'topics/browsable-api.md'
- ['topics/project-management.md', 'Topics', 'Project management'] - 'REST, Hypermedia & HATEOAS': 'topics/rest-hypermedia-hateoas.md'
- ['topics/3.0-announcement.md', 'Topics', '3.0 Announcement'] - 'Third Party Resources': 'topics/third-party-resources.md'
- ['topics/3.1-announcement.md', 'Topics', '3.1 Announcement'] - 'Contributing to REST framework': 'topics/contributing.md'
- ['topics/kickstarter-announcement.md', 'Topics', 'Kickstarter Announcement'] - 'Project management': 'topics/project-management.md'
- ['topics/release-notes.md', 'Topics', 'Release Notes'] - '3.0 Announcement': 'topics/3.0-announcement.md'
- '3.1 Announcement': 'topics/3.1-announcement.md'
- 'Kickstarter Announcement': 'topics/kickstarter-announcement.md'
- 'Release Notes': 'topics/release-notes.md'

2
requirements/requirements-documentation.txt
View File

@ -1,2 +1,2 @@
# MkDocs to build our documentation. # MkDocs to build our documentation.
mkdocs==0.12.2 mkdocs==0.13.2