2013-12-07 06:34:23 +00: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 %}
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %}
|
|
|
|
|
{%- set sphinx_writer = 'writer-html5' if html5_doctype else 'writer-html4' -%}
|
|
|
|
|
|
|
|
|
|
{# Build sphinx_version_info tuple from sphinx_version string in pure Jinja #}
|
2023-09-17 12:32:27 +00:00
|
|
|
{%- set (_ver_major, _ver_minor) = (sphinx_version.split('.') | list)[:2] | map('int') -%}
|
|
|
|
|
{%- set sphinx_version_info = (_ver_major, _ver_minor, -1) -%}
|
2013-12-07 06:34:23 +00:00
|
|
|
|
|
|
|
|
<!DOCTYPE html>
|
2023-09-17 12:32:27 +00:00
|
|
|
<html class="{{ sphinx_writer }}" lang="{{ lang_attr }}"{% if sphinx_version_info >= (7, 2) %} data-content_root="{{ content_root }}"{% endif %}>
|
2013-12-07 06:34:23 +00:00
|
|
|
<head>
|
2021-08-21 08:11:03 +00:00
|
|
|
<meta charset="utf-8" />
|
|
|
|
|
{{- metatags }}
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
|
|
|
{%- block htmltitle %}
|
2013-12-07 06:34:23 +00:00
|
|
|
<title>{{ title|striptags|e }}{{ titlesuffix }}</title>
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- endblock -%}
|
2013-12-07 06:34:23 +00:00
|
|
|
|
2021-08-21 08:11:03 +00:00
|
|
|
{#- CSS #}
|
|
|
|
|
{%- if sphinx_version_info < (4, 0) -%}
|
2013-12-07 06:34:23 +00:00
|
|
|
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
|
2021-08-21 08:11:03 +00:00
|
|
|
<link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
|
|
|
|
|
{%- endif %}
|
|
|
|
|
{%- for css in css_files %}
|
2023-09-17 12:32:27 +00:00
|
|
|
{{ css_tag(css) }}
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- endfor %}
|
2013-12-07 06:34:23 +00:00
|
|
|
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- for cssfile in extra_css_files %}
|
2023-09-17 12:32:27 +00:00
|
|
|
{{ css_tag(cssfile) }}
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- endfor -%}
|
2013-12-07 06:34:23 +00:00
|
|
|
|
2023-09-17 12:32:27 +00:00
|
|
|
{#- FAVICON
|
|
|
|
|
favicon_url is the only context var necessary since Sphinx 4.
|
|
|
|
|
In Sphinx<4, we use favicon but need to prepend path info.
|
|
|
|
|
#}
|
|
|
|
|
{%- set _favicon_url = favicon_url | default(pathto('_static/' + (favicon or ""), 1)) %}
|
|
|
|
|
{%- if favicon_url or favicon %}
|
|
|
|
|
<link rel="shortcut icon" href="{{ _favicon_url }}"/>
|
|
|
|
|
{%- endif %}
|
2021-08-21 08:11:03 +00:00
|
|
|
|
|
|
|
|
{#- CANONICAL URL (deprecated) #}
|
|
|
|
|
{%- if theme_canonical_url and not pageurl %}
|
|
|
|
|
<link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
|
|
|
|
|
{%- endif -%}
|
|
|
|
|
|
|
|
|
|
{#- CANONICAL URL #}
|
|
|
|
|
{%- if pageurl %}
|
|
|
|
|
<link rel="canonical" href="{{ pageurl|e }}" />
|
|
|
|
|
{%- endif -%}
|
|
|
|
|
|
|
|
|
|
{#- JAVASCRIPTS #}
|
|
|
|
|
{%- block scripts %}
|
|
|
|
|
<!--[if lt IE 9]>
|
|
|
|
|
<script src="{{ pathto('_static/js/html5shiv.min.js', 1) }}"></script>
|
|
|
|
|
<![endif]-->
|
|
|
|
|
{%- if not embedded %}
|
|
|
|
|
{# XXX Sphinx 1.8.0 made this an external js-file, quick fix until we refactor the template to inherert more blocks directly from sphinx #}
|
|
|
|
|
{%- if sphinx_version_info >= (1, 8) -%}
|
|
|
|
|
{%- if sphinx_version_info < (4, 0) -%}
|
|
|
|
|
<script id="documentation_options" data-url_root="{{ url_root }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
|
|
|
|
|
{%- endif -%}
|
|
|
|
|
{%- for scriptfile in script_files %}
|
|
|
|
|
{{ js_tag(scriptfile) }}
|
|
|
|
|
{%- endfor %}
|
|
|
|
|
{%- else %}
|
|
|
|
|
<script>
|
|
|
|
|
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 src="{{ pathto(scriptfile, 1) }}"></script>
|
|
|
|
|
{%- endfor %}
|
|
|
|
|
{%- endif %}
|
|
|
|
|
<script src="{{ pathto('_static/js/theme.js', 1) }}"></script>
|
|
|
|
|
|
|
|
|
|
{#- OPENSEARCH #}
|
|
|
|
|
{%- 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 %}
|
|
|
|
|
{%- endblock %}
|
2015-05-07 12:22:56 +00:00
|
|
|
|
2013-12-07 06:34:23 +00:00
|
|
|
{%- block linktags %}
|
|
|
|
|
{%- if hasdoc('about') %}
|
2021-08-21 08:11:03 +00:00
|
|
|
<link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
|
2013-12-07 06:34:23 +00:00
|
|
|
{%- endif %}
|
|
|
|
|
{%- if hasdoc('genindex') %}
|
2021-08-21 08:11:03 +00:00
|
|
|
<link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
|
2013-12-07 06:34:23 +00:00
|
|
|
{%- endif %}
|
|
|
|
|
{%- if hasdoc('search') %}
|
2021-08-21 08:11:03 +00:00
|
|
|
<link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
|
2013-12-07 06:34:23 +00:00
|
|
|
{%- endif %}
|
|
|
|
|
{%- if hasdoc('copyright') %}
|
2021-08-21 08:11:03 +00:00
|
|
|
<link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
|
2013-12-07 06:34:23 +00:00
|
|
|
{%- endif %}
|
|
|
|
|
{%- if next %}
|
2021-08-21 08:11:03 +00:00
|
|
|
<link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
|
2013-12-07 06:34:23 +00:00
|
|
|
{%- endif %}
|
|
|
|
|
{%- if prev %}
|
2021-08-21 08:11:03 +00:00
|
|
|
<link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
|
2013-12-07 06:34:23 +00:00
|
|
|
{%- endif %}
|
|
|
|
|
{%- endblock %}
|
|
|
|
|
{%- block extrahead %} {% endblock %}
|
|
|
|
|
</head>
|
|
|
|
|
|
2021-08-21 08:11:03 +00:00
|
|
|
<body class="wy-body-for-nav">
|
2013-12-07 06:34:23 +00:00
|
|
|
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- block extrabody %} {% endblock %}
|
2013-12-07 06:34:23 +00:00
|
|
|
<div class="wy-grid-for-nav">
|
2021-08-21 08:11:03 +00:00
|
|
|
{#- SIDE NAV, TOGGLES ON MOBILE #}
|
2013-12-07 06:34:23 +00:00
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
2015-11-29 10:01:10 +00:00
|
|
|
<div class="wy-side-scroll">
|
2021-08-21 08:11:03 +00:00
|
|
|
<div class="wy-side-nav-search" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}>
|
|
|
|
|
{%- block sidebartitle %}
|
2013-12-07 06:34:23 +00:00
|
|
|
|
2023-09-17 12:32:27 +00:00
|
|
|
{# the logo helper function was removed in Sphinx 6 and deprecated since Sphinx 4 #}
|
|
|
|
|
{# the master_doc variable was renamed to root_doc in Sphinx 4 (master_doc still exists in later Sphinx versions) #}
|
|
|
|
|
{%- set _logo_url = logo_url|default(pathto('_static/' + (logo or ""), 1)) %}
|
|
|
|
|
{%- set _root_doc = root_doc|default(master_doc) %}
|
|
|
|
|
<a href="{{ pathto(_root_doc) }}"{% if not theme_logo_only %} class="icon icon-home"{% endif %}>
|
|
|
|
|
{% if not theme_logo_only %}{{ project }}{% endif %}
|
|
|
|
|
{%- if logo or logo_url %}
|
|
|
|
|
<img src="{{ _logo_url }}" class="logo" alt="{{ _('Logo') }}"/>
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- endif %}
|
2015-11-29 10:01:10 +00:00
|
|
|
</a>
|
|
|
|
|
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- if theme_display_version %}
|
2015-11-29 10:01:10 +00:00
|
|
|
{%- set nav_version = version %}
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- if READTHEDOCS and current_version %}
|
2015-11-29 10:01:10 +00:00
|
|
|
{%- set nav_version = current_version %}
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- endif %}
|
|
|
|
|
{%- if nav_version %}
|
2015-11-29 10:01:10 +00:00
|
|
|
<div class="version">
|
|
|
|
|
{{ nav_version }}
|
|
|
|
|
</div>
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- endif %}
|
|
|
|
|
{%- endif %}
|
2015-05-07 12:22:56 +00:00
|
|
|
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- include "searchbox.html" %}
|
2015-05-07 12:22:56 +00:00
|
|
|
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- endblock %}
|
2015-11-29 10:01:10 +00:00
|
|
|
</div>
|
2015-05-07 12:22:56 +00:00
|
|
|
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- block navigation %}
|
|
|
|
|
{#- Translators: This is an ARIA section label for the main navigation menu -#}
|
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="{{ _('Navigation menu') }}">
|
|
|
|
|
{%- block menu %}
|
|
|
|
|
{%- set toctree = toctree(maxdepth=theme_navigation_depth|int,
|
|
|
|
|
collapse=theme_collapse_navigation|tobool,
|
|
|
|
|
includehidden=theme_includehidden|tobool,
|
|
|
|
|
titles_only=theme_titles_only|tobool) %}
|
|
|
|
|
{%- if toctree %}
|
|
|
|
|
{{ toctree }}
|
|
|
|
|
{%- else %}
|
|
|
|
|
<!-- Local TOC -->
|
|
|
|
|
<div class="local-toc">{{ toc }}</div>
|
|
|
|
|
{%- endif %}
|
|
|
|
|
{%- endblock %}
|
2015-11-29 10:01:10 +00:00
|
|
|
</div>
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- endblock %}
|
2013-12-07 06:34:23 +00:00
|
|
|
</div>
|
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
2021-08-21 08:11:03 +00:00
|
|
|
{#- MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
|
|
|
|
|
{#- Translators: This is an ARIA section label for the navigation menu that is visible when viewing the page on mobile devices -#}
|
|
|
|
|
<nav class="wy-nav-top" aria-label="{{ _('Mobile navigation menu') }}" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}>
|
|
|
|
|
{%- block mobile_nav %}
|
|
|
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
|
|
|
<a href="{{ pathto(master_doc) }}">{{ project }}</a>
|
|
|
|
|
{%- endblock %}
|
2013-12-07 06:34:23 +00:00
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
<div class="wy-nav-content">
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- block content %}
|
|
|
|
|
{%- if theme_style_external_links|tobool %}
|
|
|
|
|
<div class="rst-content style-external-links">
|
|
|
|
|
{%- else %}
|
2013-12-07 06:34:23 +00:00
|
|
|
<div class="rst-content">
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- endif %}
|
2013-12-07 06:34:23 +00:00
|
|
|
{% include "breadcrumbs.html" %}
|
2015-11-29 10:01:10 +00:00
|
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- block document %}
|
2015-11-29 10:01:10 +00:00
|
|
|
<div itemprop="articleBody">
|
2021-08-21 08:11:03 +00:00
|
|
|
{% block body %}{% endblock %}
|
2015-11-29 10:01:10 +00:00
|
|
|
</div>
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- if self.comments()|trim %}
|
|
|
|
|
<div class="articleComments">
|
|
|
|
|
{%- block comments %}{% endblock %}
|
|
|
|
|
</div>
|
|
|
|
|
{%- endif%}
|
2015-05-07 12:22:56 +00:00
|
|
|
</div>
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- endblock %}
|
2013-12-07 06:34:23 +00:00
|
|
|
{% include "footer.html" %}
|
|
|
|
|
</div>
|
2021-08-21 08:11:03 +00:00
|
|
|
{%- endblock %}
|
2013-12-07 06:34:23 +00:00
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
</div>
|
2021-08-21 08:11:03 +00:00
|
|
|
{% include "versions.html" -%}
|
2015-05-07 12:22:56 +00:00
|
|
|
|
2021-08-21 08:11:03 +00:00
|
|
|
<script>
|
2015-05-07 12:22:56 +00:00
|
|
|
jQuery(function () {
|
2021-08-21 08:11:03 +00:00
|
|
|
SphinxRtdTheme.Navigation.enable({{ 'true' if theme_sticky_navigation|tobool else 'false' }});
|
2015-05-07 12:22:56 +00:00
|
|
|
});
|
|
|
|
|
</script>
|
2021-08-21 08:11:03 +00:00
|
|
|
|
|
|
|
|
{#- Do not conflict with RTD insertion of analytics script #}
|
|
|
|
|
{%- if not READTHEDOCS %}
|
|
|
|
|
{%- if theme_analytics_id %}
|
|
|
|
|
<!-- Theme Analytics -->
|
|
|
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id={{ theme_analytics_id }}"></script>
|
|
|
|
|
<script>
|
|
|
|
|
window.dataLayer = window.dataLayer || [];
|
|
|
|
|
function gtag(){dataLayer.push(arguments);}
|
|
|
|
|
gtag('js', new Date());
|
|
|
|
|
|
|
|
|
|
gtag('config', '{{ theme_analytics_id }}', {
|
|
|
|
|
'anonymize_ip': {{ 'true' if theme_analytics_anonymize_ip|tobool else 'false' }},
|
|
|
|
|
});
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
{%- endif %}
|
|
|
|
|
{%- endif %}
|
2015-05-07 12:22:56 +00:00
|
|
|
|
|
|
|
|
{%- block footer %} {% endblock %}
|
|
|
|
|
|
2013-12-07 06:34:23 +00:00
|
|
|
</body>
|
|
|
|
|
</html>
|
