From 64523f1edcb3690402414aaed337407fcaffe81e Mon Sep 17 00:00:00 2001 From: Dougal Matthews Date: Tue, 21 Apr 2015 08:01:27 +0100 Subject: [PATCH 1/8] Update the Documentation 404.html template to subclass base.html This allows us to delete lots of code and avoid hard-coding the navigation. This does mean that {{ current_page }} isn't always available and needs to be conditionally used. --- docs_theme/404.html | 219 ++----------------------------------------- docs_theme/base.html | 32 ++++--- 2 files changed, 25 insertions(+), 226 deletions(-) diff --git a/docs_theme/404.html b/docs_theme/404.html index 44993e37d..ce520a7c1 100644 --- a/docs_theme/404.html +++ b/docs_theme/404.html @@ -1,216 +1,9 @@ - - +{% extends "base.html" %} - - - - Django REST framework - 404 - Page not found - - - - - +{% block content %} - - - - - +

404

+

Page not found

+

Try the homepage, or search the documentation.

- - - - - - - - -
- -
-
-
- GitHub - Next - Previous - Search - - - - - - Django REST framework -
- -
    - -
-
- -
-
-
- -
-
- - - -
-
-

404

-

Page not found -

-

Try the homepage, or search the documentation.

-
- -
- -
- -
- - -
-
- - - - - - - - - - - - - +{% endblock %} diff --git a/docs_theme/base.html b/docs_theme/base.html index b3066eb31..83ce0b4ce 100644 --- a/docs_theme/base.html +++ b/docs_theme/base.html @@ -8,7 +8,7 @@ - + @@ -54,7 +54,7 @@ } - +
@@ -104,7 +104,7 @@
    - {% if current_page.is_homepage %} + {% if current_page and current_page.is_homepage %}
  • Django REST framework
    • @@ -112,7 +112,7 @@ {% for toc_item in toc %} -
  • +
  • {{ toc_item.title }}
    • @@ -124,7 +124,7 @@ {% endfor %} - {% if current_page.is_homepage %} + {% if current_page and current_page.is_homepage %}
    @@ -137,15 +137,21 @@
    - {% if meta.source %} - {% for filename in meta.source %} - - {{ filename }} - - {% endfor %} - {% endif %} - {{ content }} + {% block content %} + + {% if meta.source %} + {% for filename in meta.source %} + + {{ filename }} + + {% endfor %} + {% endif %} + + {{ content }} + + {% endblock %} +
From d118cee7ddf6f685a2a938dbfe03af1a7d8a94b6 Mon Sep 17 00:00:00 2001 From: Dougal Matthews Date: Tue, 21 Apr 2015 08:04:04 +0100 Subject: [PATCH 2/8] As of MkDocs 0.12 the Home link was added back to the navigation --- docs_theme/nav.html | 1 - 1 file changed, 1 deletion(-) diff --git a/docs_theme/nav.html b/docs_theme/nav.html index ca1afc0ec..e6ab01bad 100644 --- a/docs_theme/nav.html +++ b/docs_theme/nav.html @@ -19,7 +19,6 @@ {% if include_nav %}
    -
  • Home
    • {% for nav_item in nav %} {% if nav_item.children %}
  • {{ nav_item.title }} From eae9390f1bba1e7d1f68566a4b5dc9420e29fcbf Mon Sep 17 00:00:00 2001 From: Dougal Matthews Date: Tue, 21 Apr 2015 08:05:11 +0100 Subject: [PATCH 3/8] Update to match MkDocs changes The {{ page_title }} and {{ site_name }} variables are now separated to add flexibility th themes. --- docs_theme/base.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs_theme/base.html b/docs_theme/base.html index 83ce0b4ce..497a311e5 100644 --- a/docs_theme/base.html +++ b/docs_theme/base.html @@ -4,7 +4,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta charset="utf-8"> - <title>{{ page_title }} + {% if page_title %}{{ page_title }} - {% endif %}{{ site_name }} From 33666c459b412371b4eeba76a565c544e526ffb6 Mon Sep 17 00:00:00 2001 From: Dougal Matthews Date: Tue, 21 Apr 2015 08:07:02 +0100 Subject: [PATCH 4/8] Remove Google search and replace it with Mkdocs This change updates the modal to use MkDocs for search. --- docs_theme/base.html | 24 +++++++++--------------- docs_theme/css/default.css | 4 ++++ docs_theme/nav.html | 2 +- 3 files changed, 14 insertions(+), 16 deletions(-) diff --git a/docs_theme/base.html b/docs_theme/base.html index 497a311e5..b1beecba1 100644 --- a/docs_theme/base.html +++ b/docs_theme/base.html @@ -64,27 +64,19 @@
    -