docs/_themes/sphinx_rtd_theme/layout.html

   1 {# TEMPLATE VAR SETTINGS #}
   2 {%- set url_root = pathto('', 1) %}
   3 {%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
   4 {%- if not embedded and docstitle %}
   5   {%- set titlesuffix = " &mdash; "|safe + docstitle|e %}
   6 {%- else %}
   7   {%- set titlesuffix = "" %}
   8 {%- endif %}
   9
  10 <!DOCTYPE html>
  11 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
  12 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
  13 <head>
  14   <meta charset="utf-8">
  15   <meta name="viewport" content="width=device-width, initial-scale=1.0">
  16   {% block htmltitle %}
  17   <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
  18   {% endblock %}
  19
  20   {# FAVICON #}
  21   {% if favicon %}
  22     <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
  23   {% endif %}
  24
  25   {# CSS #}
  26   <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
  27
  28   {# OPENSEARCH #}
  29   {% if not embedded %}
  30     {% if use_opensearch %}
  31       <link rel="search" type="application/opensearchdescription+xml" title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}" href="{{ pathto('_static/opensearch.xml', 1) }}"/>
  32     {% endif %}
  33
  34   {% endif %}
  35
  36   {# RTD hosts this file, so just load on non RTD builds #}
  37   {% if not READTHEDOCS %}
  38     <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
  39   {% endif %}
  40
  41   {% for cssfile in css_files %}
  42     <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
  43   {% endfor %}
  44
  45   {%- block linktags %}
  46     {%- if hasdoc('about') %}
  47         <link rel="author" title="{{ _('About these documents') }}"
  48               href="{{ pathto('about') }}"/>
  49     {%- endif %}
  50     {%- if hasdoc('genindex') %}
  51         <link rel="index" title="{{ _('Index') }}"
  52               href="{{ pathto('genindex') }}"/>
  53     {%- endif %}
  54     {%- if hasdoc('search') %}
  55         <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}"/>
  56     {%- endif %}
  57     {%- if hasdoc('copyright') %}
  58         <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}"/>
  59     {%- endif %}
  60     <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}"/>
  61     {%- if parents %}
  62         <link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}"/>
  63     {%- endif %}
  64     {%- if next %}
  65         <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}"/>
  66     {%- endif %}
  67     {%- if prev %}
  68         <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}"/>
  69     {%- endif %}
  70   {%- endblock %}
  71   {%- block extrahead %} {% endblock %}
  72
  73   {# Keep modernizr in head - http://modernizr.com/docs/#installing #}
  74   <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
  75
  76 </head>
  77
  78 <body class="wy-body-for-nav" role="document">
  79
  80   <div class="wy-grid-for-nav">
  81
  82     {# SIDE NAV, TOGGLES ON MOBILE #}
  83     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  84       <div class="wy-side-nav-search">
  85         <a href="{{ pathto(master_doc) }}" class="fa fa-home"> {{ project }}</a>
  86         {% include "searchbox.html" %}
  87       </div>
  88
  89       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  90         {% set toctree = toctree(maxdepth=2, collapse=False, includehidden=True) %}
  91         {% if toctree %}
  92             {{ toctree }}
  93         {% else %}
  94             <!-- Local TOC -->
  95             <div class="local-toc">{{ toc }}</div>
  96         {% endif %}
  97       </div>
  98       &nbsp;
  99     </nav>
 100
 101     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 102
 103       {# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
 104       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 105         <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 106         <a href="{{ pathto(master_doc) }}">{{ project }}</a>
 107       </nav>
 108
 109
 110       {# PAGE CONTENT #}
 111       <div class="wy-nav-content">
 112         <div class="rst-content">
 113           {% include "breadcrumbs.html" %}
 114           <div role="main">
 115             {% block body %}{% endblock %}
 116           </div>
 117           {% include "footer.html" %}
 118         </div>
 119       </div>
 120
 121     </section>
 122
 123   </div>
 124   {% include "versions.html" %}
 125
 126   {% if not embedded %}
 127
 128     <script type="text/javascript">
 129         var DOCUMENTATION_OPTIONS = {
 130             URL_ROOT:'{{ url_root }}',
 131             VERSION:'{{ release|e }}',
 132             COLLAPSE_INDEX:false,
 133             FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
 134             HAS_SOURCE:  {{ has_source|lower }}
 135         };
 136     </script>
 137     {%- for scriptfile in script_files %}
 138       <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
 139     {%- endfor %}
 140
 141   {% endif %}
 142
 143   {# RTD hosts this file, so just load on non RTD builds #}
 144   {% if not READTHEDOCS %}
 145     <script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script>
 146   {% endif %}
 147
 148   {# STICKY NAVIGATION #}
 149   {% if theme_sticky_navigation %}
 150   <script type="text/javascript">
 151       jQuery(function () {
 152           SphinxRtdTheme.StickyNav.enable();
 153       });
 154   </script>
 155   {% endif %}
 156
 157   {%- block footer %} {% endblock %}
 158
 159 </body>
 160 </html>