2013-12-06 17:27:56 +01:00
|
|
|
{# 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 %}
|
|
|
|
|
|
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
|
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
2015-04-01 16:11:07 +02:00
|
|
|
{{ metatags }}
|
2013-12-06 17:27:56 +01:00
|
|
|
<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 %}
|
|
|
|
|
|
|
|
|
|
{# CSS #}
|
|
|
|
|
|
2014-05-15 17:36:06 +02:00
|
|
|
{# OPENSEARCH #}
|
2013-12-06 17:27:56 +01:00
|
|
|
{% 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 %}
|
|
|
|
|
|
2014-05-15 17:36:06 +02:00
|
|
|
{# RTD hosts this file, so just load on non RTD builds #}
|
2013-12-06 17:27:56 +01:00
|
|
|
{% if not READTHEDOCS %}
|
|
|
|
|
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
|
|
|
|
|
{% endif %}
|
|
|
|
|
|
|
|
|
|
{% for cssfile in css_files %}
|
|
|
|
|
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
|
|
|
|
|
{% endfor %}
|
|
|
|
|
|
2015-04-01 16:11:07 +02:00
|
|
|
{% for cssfile in extra_css_files %}
|
|
|
|
|
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
|
|
|
|
|
{% endfor %}
|
|
|
|
|
|
2013-12-06 17:27:56 +01:00
|
|
|
{%- 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 %}
|
|
|
|
|
|
2014-05-15 17:36:06 +02:00
|
|
|
{# Keep modernizr in head - http://modernizr.com/docs/#installing #}
|
2015-10-24 12:30:51 +02:00
|
|
|
<script src="{{ pathto('_static/js/modernizr.min.js', 1) }}"></script>
|
2013-12-06 17:27:56 +01:00
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
2014-02-02 10:35:21 +01:00
|
|
|
<body class="wy-body-for-nav" role="document">
|
2013-12-06 17:27:56 +01:00
|
|
|
|
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
|
|
|
|
{# SIDE NAV, TOGGLES ON MOBILE #}
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
2015-10-24 12:30:51 +02:00
|
|
|
<div class="wy-side-scroll">
|
|
|
|
|
<div class="wy-side-nav-search">
|
|
|
|
|
{% block sidebartitle %}
|
2015-04-01 16:11:07 +02:00
|
|
|
|
2015-10-24 12:30:51 +02:00
|
|
|
{% if logo and theme_logo_only %}
|
|
|
|
|
<a href="{{ pathto(master_doc) }}">
|
|
|
|
|
{% else %}
|
|
|
|
|
<a href="{{ pathto(master_doc) }}" class="icon icon-home"> {{ project }}
|
|
|
|
|
{% endif %}
|
2015-04-01 16:11:07 +02:00
|
|
|
|
2015-10-24 12:30:51 +02:00
|
|
|
{% if logo %}
|
|
|
|
|
{# Not strictly valid HTML, but it's the only way to display/scale it properly, without weird scripting or heaps of work #}
|
|
|
|
|
<img src="{{ pathto('_static/' + logo, 1) }}" class="logo" />
|
|
|
|
|
{% endif %}
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
{% if theme_display_version %}
|
|
|
|
|
{%- set nav_version = version %}
|
|
|
|
|
{% if READTHEDOCS and current_version %}
|
|
|
|
|
{%- set nav_version = current_version %}
|
|
|
|
|
{% endif %}
|
|
|
|
|
{% if nav_version %}
|
|
|
|
|
<div class="version">
|
|
|
|
|
{{ nav_version }}
|
|
|
|
|
</div>
|
|
|
|
|
{% endif %}
|
|
|
|
|
{% endif %}
|
2015-04-01 16:11:07 +02:00
|
|
|
|
2015-10-24 12:30:51 +02:00
|
|
|
{% include "searchbox.html" %}
|
2015-04-01 16:11:07 +02:00
|
|
|
|
2015-10-24 12:30:51 +02:00
|
|
|
{% endblock %}
|
|
|
|
|
</div>
|
2013-12-06 17:27:56 +01:00
|
|
|
|
2015-10-24 12:30:51 +02:00
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
|
|
{% block menu %}
|
|
|
|
|
{% set toctree = toctree(maxdepth=4, collapse=theme_collapse_navigation, includehidden=True) %}
|
|
|
|
|
{% if toctree %}
|
|
|
|
|
{{ toctree }}
|
|
|
|
|
{% else %}
|
|
|
|
|
<!-- Local TOC -->
|
|
|
|
|
<div class="local-toc">{{ toc }}</div>
|
|
|
|
|
{% endif %}
|
|
|
|
|
{% endblock %}
|
|
|
|
|
</div>
|
2013-12-06 17:27:56 +01:00
|
|
|
</div>
|
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
|
|
|
|
{# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
|
2014-02-02 10:35:21 +01:00
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
|
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
2013-12-06 17:27:56 +01:00
|
|
|
<a href="{{ pathto(master_doc) }}">{{ project }}</a>
|
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
{# PAGE CONTENT #}
|
|
|
|
|
<div class="wy-nav-content">
|
|
|
|
|
<div class="rst-content">
|
|
|
|
|
{% include "breadcrumbs.html" %}
|
2015-10-24 12:30:51 +02:00
|
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
|
|
|
<div itemprop="articleBody">
|
2014-02-02 10:35:21 +01:00
|
|
|
{% block body %}{% endblock %}
|
2015-10-24 12:30:51 +02:00
|
|
|
</div>
|
2014-02-02 10:35:21 +01:00
|
|
|
</div>
|
2013-12-06 17:27:56 +01:00
|
|
|
{% include "footer.html" %}
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
{% include "versions.html" %}
|
2014-05-15 17:36:06 +02:00
|
|
|
|
|
|
|
|
{% if not embedded %}
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
|
|
|
var DOCUMENTATION_OPTIONS = {
|
|
|
|
|
URL_ROOT:'{{ url_root }}',
|
|
|
|
|
VERSION:'{{ release|e }}',
|
|
|
|
|
COLLAPSE_INDEX:false,
|
|
|
|
|
FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
|
|
|
|
|
HAS_SOURCE: {{ has_source|lower }}
|
|
|
|
|
};
|
|
|
|
|
</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>
|
|
|
|
|
{% endif %}
|
|
|
|
|
|
|
|
|
|
{# STICKY NAVIGATION #}
|
|
|
|
|
{% if theme_sticky_navigation %}
|
|
|
|
|
<script type="text/javascript">
|
|
|
|
|
jQuery(function () {
|
|
|
|
|
SphinxRtdTheme.StickyNav.enable();
|
|
|
|
|
});
|
|
|
|
|
</script>
|
|
|
|
|
{% endif %}
|
|
|
|
|
|
|
|
|
|
{%- block footer %} {% endblock %}
|
|
|
|
|
|
2013-12-06 17:27:56 +01:00
|
|
|
</body>
|
|
|
|
|
</html>
|
