|
| 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 = " — "|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 | + |
| 26 | + {# 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 | + {% for cssfile in extra_css_files %} |
| 46 | + <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" /> |
| 47 | + {% endfor %} |
| 48 | + |
| 49 | + {%- block linktags %} |
| 50 | + {%- if hasdoc('about') %} |
| 51 | + <link rel="author" title="{{ _('About these documents') }}" |
| 52 | + href="{{ pathto('about') }}"/> |
| 53 | + {%- endif %} |
| 54 | + {%- if hasdoc('genindex') %} |
| 55 | + <link rel="index" title="{{ _('Index') }}" |
| 56 | + href="{{ pathto('genindex') }}"/> |
| 57 | + {%- endif %} |
| 58 | + {%- if hasdoc('search') %} |
| 59 | + <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}"/> |
| 60 | + {%- endif %} |
| 61 | + {%- if hasdoc('copyright') %} |
| 62 | + <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}"/> |
| 63 | + {%- endif %} |
| 64 | + <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}"/> |
| 65 | + {%- if parents %} |
| 66 | + <link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}"/> |
| 67 | + {%- endif %} |
| 68 | + {%- if next %} |
| 69 | + <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}"/> |
| 70 | + {%- endif %} |
| 71 | + {%- if prev %} |
| 72 | + <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}"/> |
| 73 | + {%- endif %} |
| 74 | + {%- endblock %} |
| 75 | + {%- block extrahead %} {% endblock %} |
| 76 | + |
| 77 | + {# Keep modernizr in head - http://modernizr.com/docs/#installing #} |
| 78 | + <script src="{{ pathto('_static/js/modernizr.min.js', 1) }}"></script> |
| 79 | + |
| 80 | +</head> |
| 81 | + |
| 82 | +<body class="wy-body-for-nav" role="document"> |
| 83 | + |
| 84 | + <div class="wy-grid-for-nav"> |
| 85 | + |
| 86 | + {# SIDE NAV, TOGGLES ON MOBILE #} |
| 87 | + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| 88 | + <div class="wy-side-scroll"> |
| 89 | + <div class="wy-side-nav-search"> |
| 90 | + {% block sidebartitle %} |
| 91 | + |
| 92 | + {% if logo and theme_logo_only %} |
| 93 | + <a href="{{ pathto(master_doc) }}"> |
| 94 | + {% else %} |
| 95 | + <a href="{{ pathto(master_doc) }}" class="icon icon-home"> {{ project }} |
| 96 | + {% endif %} |
| 97 | + |
| 98 | + {% if logo %} |
| 99 | + {# Not strictly valid HTML, but it's the only way to display/scale it properly, without weird scripting or heaps of work #} |
| 100 | + <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" /> |
| 101 | + {% endif %} |
| 102 | + </a> |
| 103 | + |
| 104 | + {% if theme_display_version %} |
| 105 | + {%- set nav_version = version %} |
| 106 | + {% if READTHEDOCS and current_version %} |
| 107 | + {%- set nav_version = current_version %} |
| 108 | + {% endif %} |
| 109 | + {% if nav_version %} |
| 110 | + <div class="version"> |
| 111 | + {{ nav_version }} |
| 112 | + </div> |
| 113 | + {% endif %} |
| 114 | + {% endif %} |
| 115 | + |
| 116 | + {% include "searchbox.html" %} |
| 117 | + |
| 118 | + {% endblock %} |
| 119 | + </div> |
| 120 | + |
| 121 | + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| 122 | + {% block menu %} |
| 123 | + {% set toctree = toctree(maxdepth=4, collapse=theme_collapse_navigation, includehidden=True) %} |
| 124 | + {% if toctree %} |
| 125 | + {{ toctree }} |
| 126 | + {% else %} |
| 127 | + <!-- Local TOC --> |
| 128 | + <div class="local-toc">{{ toc }}</div> |
| 129 | + {% endif %} |
| 130 | + {% endblock %} |
| 131 | + </div> |
| 132 | + </div> |
| 133 | + </nav> |
| 134 | + |
| 135 | + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| 136 | + |
| 137 | + {# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #} |
| 138 | + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> |
| 139 | + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| 140 | + <a href="{{ pathto(master_doc) }}">{{ project }}</a> |
| 141 | + </nav> |
| 142 | + |
| 143 | + |
| 144 | + {# PAGE CONTENT #} |
| 145 | + <div class="wy-nav-content"> |
| 146 | + <div class="rst-content"> |
| 147 | + {% include "breadcrumbs.html" %} |
| 148 | + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| 149 | + <div itemprop="articleBody"> |
| 150 | + {% block body %}{% endblock %} |
| 151 | + </div> |
| 152 | + </div> |
| 153 | + {% include "footer.html" %} |
| 154 | + </div> |
| 155 | + </div> |
| 156 | + |
| 157 | + </section> |
| 158 | + |
| 159 | + </div> |
| 160 | + {% include "versions.html" %} |
| 161 | + |
| 162 | + {% if not embedded %} |
| 163 | + |
| 164 | + <script type="text/javascript"> |
| 165 | + var DOCUMENTATION_OPTIONS = { |
| 166 | + URL_ROOT:'{{ url_root }}', |
| 167 | + VERSION:'{{ release|e }}', |
| 168 | + COLLAPSE_INDEX:false, |
| 169 | + FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}', |
| 170 | + HAS_SOURCE: {{ has_source|lower }} |
| 171 | + }; |
| 172 | + </script> |
| 173 | + {%- for scriptfile in script_files %} |
| 174 | + <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script> |
| 175 | + {%- endfor %} |
| 176 | + |
| 177 | + {% endif %} |
| 178 | + |
| 179 | + {# RTD hosts this file, so just load on non RTD builds #} |
| 180 | + {% if not READTHEDOCS %} |
| 181 | + <script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script> |
| 182 | + {% endif %} |
| 183 | + |
| 184 | + {# STICKY NAVIGATION #} |
| 185 | + {% if theme_sticky_navigation %} |
| 186 | + <script type="text/javascript"> |
| 187 | + jQuery(function () { |
| 188 | + SphinxRtdTheme.StickyNav.enable(); |
| 189 | + }); |
| 190 | + </script> |
| 191 | + {% endif %} |
| 192 | + |
| 193 | + {%- block footer %} {% endblock %} |
| 194 | + |
| 195 | +</body> |
| 196 | +</html> |
0 commit comments