Refactor HTML templates

sphinx_rtd_theme/breadcrumbs.html

@@ -1,35 +1,35 @@
-{# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #}
+{# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. -#}
 
-{% if page_source_suffix %}
+{%- if page_source_suffix %}
 {% set suffix = page_source_suffix %}
 {% else %}
 {% set suffix = source_suffix %}
-{% endif %}
+{% endif -%}
 
-{% if meta is defined and meta is not none %}
+{%- if meta is defined and meta is not none %}
 {% set check_meta = True %}
 {% else %}
 {% set check_meta = False %}
-{% endif %}
+{% endif -%}
 
-{% if check_meta and 'github_url' in meta %}
+{%- if check_meta and 'github_url' in meta %}
 {% set display_github = True %}
-{% endif %}
+{% endif -%}
 
-{% if check_meta and 'bitbucket_url' in meta %}
+{%- if check_meta and 'bitbucket_url' in meta %}
 {% set display_bitbucket = True %}
-{% endif %}
+{% endif -%}
 
-{% if check_meta and 'gitlab_url' in meta %}
+{%- if check_meta and 'gitlab_url' in meta %}
 {% set display_gitlab = True %}
-{% endif %}
+{% endif -%}
 
 <div role="navigation" aria-label="breadcrumbs navigation">
 
   <ul class="wy-breadcrumbs">
     {% block breadcrumbs %}
       <li><a href="{{ pathto(master_doc) }}">{{ _('Docs') }}</a> &raquo;</li>
-        {% for doc in parents %}
+        {%- for doc in parents %}
           <li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
         {% endfor %}
       <li>{{ title }}</li>

sphinx_rtd_theme/footer.html

@@ -1,5 +1,5 @@
 <footer>
-  {% if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
+  {%- if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
       {% if next %}
         <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right"></span></a>
@@ -8,44 +8,29 @@
         <a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> {{ _('Previous') }}</a>
       {% endif %}
     </div>
-  {% endif %}
+  {%- endif %}
 
   <hr/>
 
   <div role="contentinfo">
     <p>
-    {%- if show_copyright %}
-      {%- if hasdoc('copyright') %}
-        {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
-      {%- else %}
-        {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
-      {%- endif %}
-    {%- endif %}
-
     {%- if build_id and build_url %}
-      {% trans build_url=build_url, build_id=build_id %}
+      {%- trans build_url=build_url, build_id=build_id %}
         <span class="build">
           Build
           <a href="{{ build_url }}">{{ build_id }}</a>.
         </span>
-      {% endtrans %}
+      {%- endtrans %}
     {%- elif commit %}
-      {% trans commit=commit %}
+      {%- trans commit=commit %}
         <span class="commit">
           Revision <code>{{ commit }}</code>.
         </span>
-      {% endtrans %}
-    {%- elif last_updated %}
-      {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
+      {%- endtrans %}
     {%- endif %}
-
     </p>
   </div>
 
-  {%- if show_sphinx %}
-  {% trans %}Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %}.
-  {%- endif %}
-
   {%- block extrafooter %} {% endblock %}
 
 </footer>

sphinx_rtd_theme/layout.html

@@ -1,43 +1,19 @@
-{# TEMPLATE VAR SETTINGS #}
-{%- set url_root = pathto('', 1) %}
-{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
-{%- if not embedded and docstitle %}
-  {%- set titlesuffix = " — "|safe + docstitle|e %}
-{%- else %}
-  {%- set titlesuffix = "" %}
-{%- endif %}
-{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %}
+{%- extends "basic/layout.html" %}
 
+{%- block doctype -%}
 <!DOCTYPE html>
-<!--[if IE 8]><html class="no-js lt-ie9" lang="{{ lang_attr }}" > <![endif]-->
-<!--[if gt IE 8]><!--> <html class="no-js" lang="{{ lang_attr }}" > <!--<![endif]-->
-<head>
-  <meta charset="utf-8">
-  {{ metatags }}
+{%- endblock %}
+{% block relbar1 %}{% endblock %}
+{% block relbar2 %}{% endblock %}
+
+{%- block extrahead %}
+  {{ super() }}
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  {% block htmltitle %}
-  <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
-  {% endblock %}
 
-  {# FAVICON #}
-  {% if favicon %}
-    <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
-  {% endif %}
-  {# CANONICAL URL #}
   {% if theme_canonical_url %}
     <link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
   {% endif %}
 
-  {# CSS #}
-
-  {# OPENSEARCH #}
-  {% if not embedded %}
-    {% if use_opensearch %}
-      <link rel="search" type="application/opensearchdescription+xml" title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}" href="{{ pathto('_static/opensearch.xml', 1) }}"/>
-    {% endif %}
-
-  {% endif %}
-
   {# RTD hosts this file, so just load on non RTD builds #}
   {% if not READTHEDOCS %}
     <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
@@ -53,41 +29,14 @@
     <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
   {% endfor %}
 
-  {%- block linktags %}
-    {%- if hasdoc('about') %}
-        <link rel="author" title="{{ _('About these documents') }}"
-              href="{{ pathto('about') }}"/>
-    {%- endif %}
-    {%- if hasdoc('genindex') %}
-        <link rel="index" title="{{ _('Index') }}"
-              href="{{ pathto('genindex') }}"/>
-    {%- endif %}
-    {%- if hasdoc('search') %}
-        <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}"/>
-    {%- endif %}
-    {%- if hasdoc('copyright') %}
-        <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}"/>
-    {%- endif %}
-    <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}"/>
-    {%- if parents %}
-        <link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}"/>
-    {%- endif %}
-    {%- if next %}
-        <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}"/>
-    {%- endif %}
-    {%- if prev %}
-        <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}"/>
-    {%- endif %}
-  {%- endblock %}
-  {%- block extrahead %} {% endblock %}
-
   {# Keep modernizr in head - http://modernizr.com/docs/#installing #}
   <script src="{{ pathto('_static/js/modernizr.min.js', 1) }}"></script>
+{% endblock %}
 
-</head>
-
-<body class="wy-body-for-nav">
+{%- block body_tag %}<body class="wy-body-for-nav">{% endblock %}
 
+{%- block content %}
+  {%- block document %}
   {% block extrabody %} {% endblock %}
   <div class="wy-grid-for-nav">
 
@@ -122,7 +71,6 @@
           {% endif %}
 
           {% include "searchbox.html" %}
-
           {% endblock %}
         </div>
 
@@ -185,25 +133,6 @@
   </div>
   {% include "versions.html" %}
 
-  {% if not embedded %}
-
-    <script type="text/javascript">
-        var DOCUMENTATION_OPTIONS = {
-            URL_ROOT:'{{ url_root }}',
-            VERSION:'{{ release|e }}',
-            LANGUAGE:'{{ language }}',
-            COLLAPSE_INDEX:false,
-            FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
-            HAS_SOURCE:  {{ has_source|lower }},
-            SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
-        };
-    </script>
-    {%- for scriptfile in script_files %}
-      <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
-    {%- endfor %}
-
-  {% endif %}
-
   {# RTD hosts this file, so just load on non RTD builds #}
   {% if not READTHEDOCS %}
     <script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script>
@@ -219,7 +148,6 @@
       });
   </script>
 
+  {%- endblock %}
+  {%- endblock %}
   {%- block footer %} {% endblock %}
-
-</body>
-</html>