docs/v_2_2_0/_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   {{ metatags }}
  16   <meta name="viewport" content="width=device-width, initial-scale=1.0">
  17   {% block htmltitle %}
  18   <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
  19   {% endblock %}
  20
  21   {# FAVICON #}
  22   {% if favicon %}
  23     <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
  24   {% endif %}
  25   {# CANONICAL URL #}
  26   {% if theme_canonical_url %}
  27     <link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
  28   {% endif %}
  29
  30   {# CSS #}
  31
  32   {# OPENSEARCH #}
  33   {% if not embedded %}
  34     {% if use_opensearch %}
  35       <link rel="search" type="application/opensearchdescription+xml" title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}" href="{{ pathto('_static/opensearch.xml', 1) }}"/>
  36     {% endif %}
  37
  38   {% endif %}
  39
  40   {# RTD hosts this file, so just load on non RTD builds #}
  41   {% if not READTHEDOCS %}
  42     <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
  43   {% endif %}
  44
  45   {% for cssfile in css_files %}
  46     <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
  47   {% endfor %}
  48
  49   {% for cssfile in extra_css_files %}
  50     <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
  51   {% endfor %}
  52
  53   {%- block linktags %}
  54     {%- if hasdoc('about') %}
  55         <link rel="author" title="{{ _('About these documents') }}"
  56               href="{{ pathto('about') }}"/>
  57     {%- endif %}
  58     {%- if hasdoc('genindex') %}
  59         <link rel="index" title="{{ _('Index') }}"
  60               href="{{ pathto('genindex') }}"/>
  61     {%- endif %}
  62     {%- if hasdoc('search') %}
  63         <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}"/>
  64     {%- endif %}
  65     {%- if hasdoc('copyright') %}
  66         <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}"/>
  67     {%- endif %}
  68     <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}"/>
  69     {%- if parents %}
  70         <link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}"/>
  71     {%- endif %}
  72     {%- if next %}
  73         <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}"/>
  74     {%- endif %}
  75     {%- if prev %}
  76         <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}"/>
  77     {%- endif %}
  78   {%- endblock %}
  79   {%- block extrahead %} {% endblock %}
  80
  81   {# Keep modernizr in head - http://modernizr.com/docs/#installing #}
  82   <script src="{{ pathto('_static/js/modernizr.min.js', 1) }}"></script>
  83
  84 </head>
  85
  86 <body class="wy-body-for-nav" role="document">
  87
  88   {% block extrabody %} {% endblock %}
  89   <div class="wy-grid-for-nav">
  90
  91     {# SIDE NAV, TOGGLES ON MOBILE #}
  92     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  93       <div class="wy-side-scroll">
  94         <div class="wy-side-nav-search">
  95           {% block sidebartitle %}
  96
  97           {% if logo and theme_logo_only %}
  98             <a href="{{ pathto(master_doc) }}">
  99           {% else %}
 100             <a href="{{ pathto(master_doc) }}" class="icon icon-home"> {{ project }}
 101           {% endif %}
 102
 103           {% if logo %}
 104             {# Not strictly valid HTML, but it's the only way to display/scale it properly, without weird scripting or heaps of work #}
 105             <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" />
 106           {% endif %}
 107           </a>
 108
 109           {% if theme_display_version %}
 110             {%- set nav_version = version %}
 111             {% if READTHEDOCS and current_version %}
 112               {%- set nav_version = current_version %}
 113             {% endif %}
 114             {% if nav_version %}
 115               <div class="version">
 116                 {{ nav_version }}
 117               </div>
 118             {% endif %}
 119           {% endif %}
 120
 121           {% include "searchbox.html" %}
 122
 123           {% endblock %}
 124         </div>
 125
 126         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
 127           {% block menu %}
 128             {#
 129               The singlehtml builder doesn't handle this toctree call when the
 130               toctree is empty. Skip building this for now.
 131             #}
 132             {% if 'singlehtml' not in builder %}
 133               {% set global_toc = toctree(maxdepth=theme_navigation_depth|int, collapse=theme_collapse_navigation, includehidden=True) %}
 134             {% endif %}
 135             {% if global_toc %}
 136               {{ global_toc }}
 137             {% else %}
 138               <!-- Local TOC -->
 139               <div class="local-toc">{{ toc }}</div>
 140             {% endif %}
 141           {% endblock %}
 142         </div>
 143       </div>
 144     </nav>
 145
 146     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 147
 148       {# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
 149       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 150         {% block mobile_nav %}
 151           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 152           <a href="{{ pathto(master_doc) }}">{{ project }}</a>
 153         {% endblock %}
 154       </nav>
 155
 156
 157       {# PAGE CONTENT #}
 158       <div class="wy-nav-content">
 159         <div class="rst-content">
 160           {% include "breadcrumbs.html" %}
 161           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 162            <div itemprop="articleBody">
 163             {% block body %}{% endblock %}
 164            </div>
 165            <div class="articleComments">
 166             {% block comments %}{% endblock %}
 167            </div>
 168           </div>
 169           {% include "footer.html" %}
 170         </div>
 171       </div>
 172
 173     </section>
 174
 175   </div>
 176   {% include "versions.html" %}
 177
 178   {% if not embedded %}
 179
 180     <script type="text/javascript">
 181         var DOCUMENTATION_OPTIONS = {
 182             URL_ROOT:'{{ url_root }}',
 183             VERSION:'{{ release|e }}',
 184             LANGUAGE:'{{ language }}',
 185             COLLAPSE_INDEX:false,
 186             FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
 187             HAS_SOURCE:  {{ has_source|lower }},
 188             SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
 189         };
 190     </script>
 191     {%- for scriptfile in script_files %}
 192       <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
 193     {%- endfor %}
 194
 195   {% endif %}
 196
 197   {# RTD hosts this file, so just load on non RTD builds #}
 198   {% if not READTHEDOCS %}
 199     <script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script>
 200   {% endif %}
 201
 202   {# STICKY NAVIGATION #}
 203   {% if theme_sticky_navigation %}
 204   <script type="text/javascript">
 205       jQuery(function () {
 206           SphinxRtdTheme.StickyNav.enable();
 207       });
 208   </script>
 209   {% endif %}
 210
 211   {%- block footer %} {% endblock %}
 212
 213 </body>
 214 </html>