1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
|
{% extends 'base.html' %}
{% macro entry_class(class) %}{% include 'entry-class.html' %}{% endmacro %}
{% macro entry_enum(enum) %}{% include 'entry-enum.html' %}{% endmacro %}
{% macro entry_function(function) %}{% include 'entry-function.html' %}{% endmacro %}
{% macro entry_property(property) %}{% include 'entry-property.html' %}{% endmacro %}
{% macro entry_data(data) %}{% include 'entry-data.html' %}{% endmacro %}
{% macro details_enum(enum, prefix) %}{% include 'details-enum.html' %}{% endmacro %}
{% macro details_function(function, prefix) %}{% include 'details-function.html' %}{% endmacro %}
{% macro details_property(property, prefix) %}{% include 'details-property.html' %}{% endmacro %}
{% macro details_data(data, prefix) %}{% include 'details-data.html' %}{% endmacro %}
{% block title %}{% set j = joiner('.') %}{% for name, _ in page.breadcrumb %}{{ j() }}{{ name }}{% endfor %} | {{ super() }}{% endblock %}
{% block main %}
<h1>
{%+ for name, target in page.breadcrumb[:-1] %}<span class="m-breadcrumb"><a href="{{ target }}">{{ name }}</a>.<wbr/></span>{% endfor %}{{ page.breadcrumb[-1][0] }} <span class="m-thin">class</span>
</h1>
{% if page.summary %}
<p>{{ page.summary }}</p>
{% endif %}
{% if page.classes or page.classmethods or page.staticmethods or page.methods or page.dunder_methods or page.properties or page.data %}
<nav class="m-block m-default">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
{% if page.classes %}
<li><a href="#classes">Classes</a></li>
{% endif %}
{% if page.enums %}
<li><a href="#enums">Enums</a></li>
{% endif %}
{% if page.classmethods %}
<li><a href="#classmethods">Class methods</a></li>
{% endif %}
{% if page.staticmethods %}
<li><a href="#staticmethods">Static methods</a></li>
{% endif %}
{% if page.methods %}
<li><a href="#methods">Methods</a></li>
{% endif %}
{% if page.dunder_methods %}
<li><a href="#dunder-methods">Special methods</a></li>
{% endif %}
{% if page.properties %}
<li><a href="#properties">Properties</a></li>
{% endif %}
{% if page.data %}
<li><a href="#data">Data</a></li>
{% endif %}
</ul>
</li>
</ul>
</nav>
{% endif %}
{% if page.content %}
{{ page.content }}
{% endif %}
{% if page.classes %}
<section id="classes">
<h2><a href="#classes">Classes</a></h2>
<dl class="m-doc">
{% for class in page.classes %}
{{ entry_class(class) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if page.enums %}
<section id="enums">
<h2><a href="#enums">Enums</a></h2>
<dl class="m-doc">
{% for enum in page.enums %}
{{ entry_enum(enum) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if page.classmethods %}
<section id="classmethods">
<h2><a href="#classmethods">Class methods</a></h2>
<dl class="m-doc">
{% for function in page.classmethods %}
{{ entry_function(function) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if page.staticmethods %}
<section id="staticmethods">
<h2><a href="#staticmethods">Static methods</a></h2>
<dl class="m-doc">
{% for function in page.staticmethods %}
{{ entry_function(function) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if page.methods %}
<section id="methods">
<h2><a href="#methods">Methods</a></h2>
<dl class="m-doc">
{% for function in page.methods %}
{{ entry_function(function) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if page.dunder_methods %}
<section id="dunder-methods">
<h2><a href="#dunder-methods">Special methods</a></h2>
<dl class="m-doc">
{% for function in page.dunder_methods %}
{{ entry_function(function) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if page.properties %}
<section id="properties">
<h2><a href="#properties">Properties</a></h2>
<dl class="m-doc">
{% for property in page.properties %}
{{ entry_property(property) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if page.data %}
<section id="data">
<h2><a href="#data">Data</a></h2>
<dl class="m-doc">
{% for data in page.data %}
{{ entry_data(data) }}
{% endfor %}
</dl>
</section>
{% endif %}
{% if page.has_enum_details %}
<section>
<h2>Enum documentation</h2>
{% for enum in page.enums %}
{% if enum.has_details %}
{{ details_enum(enum, page.prefix_wbr) }}
{% endif %}
{% endfor %}
</section>
{% endif %}
{% if page.has_function_details %}
<section>
<h2>Method documentation</h2>
{% for function in page.classmethods %}
{% if function.has_details %}
{{ details_function(function, page.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for function in page.staticmethods %}
{% if function.has_details %}
{{ details_function(function, page.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for function in page.methods %}
{% if function.has_details %}
{{ details_function(function, page.prefix_wbr) }}
{% endif %}
{% endfor %}
{% for function in page.dunder_methods %}
{% if function.has_details %}
{{ details_function(function, page.prefix_wbr) }}
{% endif %}
{% endfor %}
</section>
{% endif %}
{% if page.has_property_details %}
<section>
<h2>Property documentation</h2>
{% for property in page.properties %}
{% if property.has_details %}
{{ details_property(property, page.prefix_wbr) }}
{% endif %}
{% endfor %}
</section>
{% endif %}
{% if page.has_data_details %}
<section>
<h2>Data documentation</h2>
{% for data in page.data %}
{% if data.has_details %}
{{ details_data(data, page.prefix_wbr) }}
{% endif %}
{% endfor %}
</section>
{% endif %}
{% endblock %}
|