aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDougal Matthews2014-10-29 22:29:41 +0000
committerDougal Matthews2014-11-25 12:43:42 +0000
commit5d479c20d8b9a376057517a4d53d58ff891f5483 (patch)
tree515ecba6ced0f24998f0b6458937a9e3c8522993
parentb443f81481815423d0f953ca41052b4993dfb12f (diff)
downloaddjango-rest-framework-5d479c20d8b9a376057517a4d53d58ff891f5483.tar.bz2
Move nav to it's own template based on the MkDocs theme
-rw-r--r--docs/theme/base.html93
-rw-r--r--docs/theme/nav.html45
2 files changed, 46 insertions, 92 deletions
diff --git a/docs/theme/base.html b/docs/theme/base.html
index 5187d581..4ca6cd81 100644
--- a/docs/theme/base.html
+++ b/docs/theme/base.html
@@ -54,98 +54,7 @@ a.fusion-poweredby {
<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 {% if not next_page %}disabled{% endif %}" href="{{ next_page.url }}">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 %}" href="{{ previous_page.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>
- <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">
- <li><a href="{{ base_url }}/tutorial/quickstart{{ suffix }}">Quickstart</a></li>
- <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>
- <li><a href="{{ base_url }}/tutorial/4-authentication-and-permissions{{ suffix }}">4 - Authentication and permissions</a></li>
- <li><a href="{{ base_url }}/tutorial/5-relationships-and-hyperlinked-apis{{ suffix }}">5 - Relationships and hyperlinked APIs</a></li>
- <li><a href="{{ base_url }}/tutorial/6-viewsets-and-routers{{ suffix }}">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="{{ 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>
- <li><a href="{{ base_url }}/api-guide/generic-views{{ suffix }}">Generic views</a></li>
- <li><a href="{{ base_url }}/api-guide/viewsets{{ suffix }}">Viewsets</a></li>
- <li><a href="{{ base_url }}/api-guide/routers{{ suffix }}">Routers</a></li>
- <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>
- <li><a href="{{ base_url }}/api-guide/fields{{ suffix }}">Serializer fields</a></li>
- <li><a href="{{ base_url }}/api-guide/relations{{ suffix }}">Serializer relations</a></li>
- <li><a href="{{ base_url }}/api-guide/validators{{ suffix }}">Validators</a></li>
- <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>
- <li><a href="{{ base_url }}/api-guide/filtering{{ suffix }}">Filtering</a></li>
- <li><a href="{{ base_url }}/api-guide/pagination{{ suffix }}">Pagination</a></li>
- <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>
- <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>
- <li><a href="{{ base_url }}/api-guide/testing{{ suffix }}">Testing</a></li>
- <li><a href="{{ base_url }}/api-guide/settings{{ suffix }}">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="{{ base_url }}/topics/documenting-your-api{{ suffix }}">Documenting your API</a></li>
- <li><a href="{{ base_url }}/topics/ajax-csrf-cors{{ suffix }}">AJAX, CSRF & CORS</a></li>
- <li><a href="{{ base_url }}/topics/browser-enhancements{{ suffix }}">Browser enhancements</a></li>
- <li><a href="{{ base_url }}/topics/browsable-api{{ suffix }}">The Browsable API</a></li>
- <li><a href="{{ base_url }}/topics/rest-hypermedia-hateoas{{ suffix }}">REST, Hypermedia & HATEOAS</a></li>
- <li><a href="{{ base_url }}/topics/third-party-resources{{ suffix }}">Third Party Resources</a></li>
- <li><a href="{{ base_url }}/topics/contributing{{ suffix }}">Contributing to REST framework</a></li>
- <li><a href="{{ base_url }}/topics/rest-framework-2-announcement{{ suffix }}">2.0 Announcement</a></li>
- <li><a href="{{ base_url }}/topics/2.2-announcement{{ suffix }}">2.2 Announcement</a></li>
- <li><a href="{{ base_url }}/topics/2.3-announcement{{ suffix }}">2.3 Announcement</a></li>
- <li><a href="{{ base_url }}/topics/2.4-announcement{{ suffix }}">2.4 Announcement</a></li>
- <li><a href="{{ base_url }}/topics/kickstarter-announcement{{ suffix }}">Kickstarter Announcement</a></li>
- <li><a href="{{ base_url }}/topics/release-notes{{ suffix }}">Release Notes</a></li>
- <li><a href="{{ base_url }}/topics/credits{{ suffix }}">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>
+ {% include "nav.html" %}
<div class="body-content">
<div class="container-fluid">
diff --git a/docs/theme/nav.html b/docs/theme/nav.html
new file mode 100644
index 00000000..a7a72d68
--- /dev/null
+++ b/docs/theme/nav.html
@@ -0,0 +1,45 @@
+
+ <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 " href="tutorial/quickstart">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">
+ {% if include_nav %}
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav">
+ {% 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>