aboutsummaryrefslogtreecommitdiff
blob: 2d451fba82dfbdd97f3a49a57a5c2d22883e2b29 (plain)
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
{%- block doctype -%}
{%- if html5_doctype %}
<!doctype html>
{%- else %}
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
{%- endif %}{%- endblock %}
{%- set reldelim1 = reldelim1 is not defined and ' &#187;' or reldelim1 %}
{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %}
{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %}
{%- set url_root = pathto('', 1) %}
{# XXX necessary? #}
{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
{%- if not embedded and docstitle %}
  {%- set titlesuffix = " &#8212; "|safe + docstitle|e %}
{%- else %}
  {%- set titlesuffix = "" %}
{%- endif %}

{%- macro script() %}
    <script type="text/javascript" id="documentation_options" data-url_root="{{ pathto('', 1) }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
    {%- for js in script_files %}
    {{ js_tag(js) }}
    {%- endfor %}
{%- endmacro %}

{%- macro css() %}
    <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
    <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
    <link rel="stylesheet" href="{{ pathto('_static/custom.css', 1) }}" type="text/css" />

    <link rel="icon" href="https://www.gentoo.org/favicon.ico" type="image/x-icon">
    <link href="https://assets.gentoo.org/tyrian/bootstrap.min.css" rel="stylesheet" media="screen">
    <link href="https://assets.gentoo.org/tyrian/tyrian.min.css" rel="stylesheet" media="screen">
    {%- for css in css_files %}
      {%- if css|attr("filename") %}
    {{ css_tag(css) }}
      {%- else %}
    <link rel="stylesheet" href="{{ pathto(css, 1) }}" type="text/css" />
      {%- endif %}
    {%- endfor %}
{%- endmacro %}

{%- macro sidebar() %}
<div class="" role="navigation" aria-label="main navigation">
    <div class="">
        {%- block sidebarlogo %}
        {%- if logo %}
        <p class="logo"><a href="{{ pathto(master_doc) }}">
            <img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
        </a></p>
        {%- endif %}
        {%- endblock %}

        {%- if sidebars != None %}
        {#- new style sidebar: explicitly include/exclude templates #}
        {%- for sidebartemplate in sidebars %}
        {%- include sidebartemplate %}
        {%- endfor %}
        {%- else %}
        {#- old style sidebars: using blocks -- should be deprecated #}
        {%- block sidebartoc %}
        {%- include "localtoc.html" %}
        {%- endblock %}
        {%- block sidebarrel %}
        {%- include "relations.html" %}
        {%- endblock %}
        {%- block sidebarsourcelink %}
        {%- include "sourcelink.html" %}
        {%- endblock %}
        {%- if customsidebar %}
        {%- include customsidebar %}
        {%- endif %}
        {%- block sidebarsearch %}
        {%- include "searchbox.html" %}
        {%- endblock %}
        {%- endif %}
    </div>
</div>
{%- endmacro %}

{%- macro navlinks(navlink_style) %}
    {% if navlink_style != "none" %}
        {% if prev or next %}
        <div class="row" style="margin-top:50px;">
            <div class="col-sm-6">
                {% if prev %}
                <a href="{{ prev.link|e }}" style="color:#767676;">
                    <i class="fa fa-angle-double-left" aria-hidden="true"></i>
                    {% if navlink_style == "long" %}
                        {{ prev.title }}
                    {% endif %}
                </a>
                {% endif %}
            </div>

            <div class="col-sm-6">
                {% if next %}
                <a href="{{ next.link|e }}" class="pull-right" style="color:#767676;">
                    {% if navlink_style == "long" %}
                        {{ next.title }}
                    {% endif %}
                    <i class="fa fa-angle-double-right" aria-hidden="true"></i>
                </a>
                {% endif %}
            </div>
        </div>
        {% endif %}
    {% endif %}
{%- endmacro %}


{%- if html_tag %}
{{ html_tag }}
{%- else %}
<html xmlns="http://www.w3.org/1999/xhtml"{% if language is not none %} lang="{{ language }}"{% endif %}>
{%- endif %}
  <head>
      <meta charset="utf-8">
      <meta http-equiv="X-UA-Compatible" content="IE=edge">
      <meta name="viewport" content="width=device-width, initial-scale=1">
    {{- metatags }}
    {%- block htmltitle %}
    <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
    {%- endblock %}
    {%- block css %}
    {{- css() }}
    {%- endblock %}
    {%- if not embedded %}
    {%- block scripts %}
    {{- script() }}
    {%- endblock %}
    {%- if pageurl %}
    <link rel="canonical" href="{{ pageurl }}" />
    {%- endif %}
    {%- 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 %}
    {%- if favicon %}
    <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
    {%- endif %}
    {%- endif %}
{%- 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 %}
    {%- 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 %}
  </head>
  {%- block body_tag %}<body>{% endblock %}


{%- block header %}
    <header>
        <div class="site-title">
            <div class="container">
                <div class="row">
                    <div class="site-title-buttons">
                        <div class="btn-group btn-group-sm">
                            <a href="https://get.gentoo.org/" role="button" class="btn get-gentoo"><span class="fa fa-fw fa-download"></span> <strong>Get Gentoo!</strong></a>
                            <div class="btn-group btn-group-sm">
                                <a class="btn gentoo-org-sites dropdown-toggle" data-toggle="dropdown" data-target="#" href="#">
                                    <span class="fa fa-fw fa-map-o"></span> <span class="hidden-xs">gentoo.org sites</span> <span class="caret"></span>
                                </a>
                                <ul class="dropdown-menu dropdown-menu-right">
                                    <li><a href="https://www.gentoo.org/" title="Main Gentoo website"><span class="fa fa-home fa-fw"></span> gentoo.org</a></li>
                                    <li><a href="https://wiki.gentoo.org/" title="Find and contribute documentation"><span class="fa fa-file-text-o fa-fw"></span> Wiki</a></li>
                                    <li><a href="https://bugs.gentoo.org/" title="Report issues and find common issues"><span class="fa fa-bug fa-fw"></span> Bugs</a></li>
                                    <li><a href="https://forums.gentoo.org/" title="Discuss with the community"><span class="fa fa-comments-o fa-fw"></span> Forums</a></li>
                                    <li><a href="https://packages.gentoo.org/" title="Find software for your Gentoo"><span class="fa fa-hdd-o fa-fw"></span> Packages</a></li>
                                    <li class="divider"></li>
                                    <li><a href="https://planet.gentoo.org/" title="Find out what's going on in the developer community"><span class="fa fa-rss fa-fw"></span> Planet</a></li>
                                    <li><a href="https://archives.gentoo.org/" title="Read up on past discussions"><span class="fa fa-archive fa-fw"></span> Archives</a></li>
                                    <li><a href="https://sources.gentoo.org/" title="Browse our source code"><span class="fa fa-code fa-fw"></span> Sources</a></li>
                                    <li class="divider"></li>
                                    <li><a href="https://infra-status.gentoo.org/" title="Get updates on the services provided by Gentoo"><span class="fa fa-server fa-fw"></span> Infra Status</a></li>
                                </ul>
                            </div>
                        </div>
                    </div>
                    <div class="logo">
                        <a href="index.html" title="Back to the homepage" class="site-logo"></a>
                        <span class="site-label">{{ docstitle|replace("Gentoo","")|replace("documentation","") }}</span>
                    </div>
                </div>
            </div>
        </div>
        <nav class="tyrian-navbar" role="navigation">
            <div class="container">
                <div class="row">
                    <div class="navbar-header">
                        <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-main-collapse">
                            <span class="sr-only">Toggle navigation</span>
                            <span class="icon-bar"></span>
                            <span class="icon-bar"></span>
                            <span class="icon-bar"></span>
                        </button>
                    </div>
                    <div class="collapse navbar-collapse navbar-main-collapse">
                        <ul class="nav navbar-nav">
                            {%- if pagename == "index" %}
                            <li class="active">
                            {%- else %}
                            <li>
                            {%- endif %}
                            <a href="index.html">Home</a></li>

                            {%- if show_source %}
                                {%- if builder != "singlehtml" and has_source and sourcename %}
                                    <li class=""><a href="{{ pathto('_sources/' + sourcename, true)|e }}">Source</a></li>
                                {%- else %}
                                    <li class=""><a href="https://gitweb.gentoo.org/proj/policy-guide.git/">Source</a></li>
                                {%- endif %}
                            {%- endif %}

                            {%- if builder != "singlehtml" %}
                                    {%- if pagename == "search" %}
                                        <li class="active">
                                    {%- else %}
                                        <li>
                                    {%- endif %}
                                    <a href="search.html">Search</a></li>

                                {%- if pagename == "genindex" %}
                                <li class="active">
                                    {%- else %}
                                <li>
                                {%- endif %}
                                <a href="genindex.html">Index</a></li>
                            {%- endif %}

                            {% if theme_navigationlinks_navbar != "none" %}
                                <li class="disabled"><a>|</a></li>
                                {% if prev %}
                                    <li>
                                        <a href="{{ prev.link|e }}">
                                            <i class="fa fa-angle-double-left" aria-hidden="true"></i>
                                            {% if theme_navigationlinks_navbar == "long" %}
                                            {{ prev.title }}
                                            {% endif %}
                                        </a>
                                    </li>
                                {%- endif %}

                                {% if next %}
                                    <li>
                                        <a href="{{ next.link|e }}">
                                            {% if theme_navigationlinks_navbar == "long" %}
                                            {{ next.title }}
                                            {% endif %}
                                            <i class="fa fa-angle-double-right" aria-hidden="true"></i>
                                        </a>
                                    </li>
                                {%- endif %}


                            {%- endif %}

                        </ul>


                        {%- if builder == "singlehtml" %}

                            <form action="index.html" class="navbar-form navbar-right" method="get" onsubmit="if (this.quicksearch.value == '')
                          { alert('Please enter one or more search terms first.');
                            return false; } return true;">

                                <div class="input-group" style="margin-top:2px;">
                                    <span class="input-group-addon" style="background:#61597b;color:#FFF;border:0px;" id="basic-addon1"><i class="fa fa-search" aria-hidden="true"></i></span>
                                    <input class="form-control" style="height:30px;border:0px;background:#61597b;color:#FFF;padding-left:0px;box-shadow: none;" type="text" id="highlight" name="highlight" title="Quick Search" placeholder="Quick Search" value="">
                                </div>
                                <button class="btn btn-default hidden" type="submit" value="Search" id="find_top">Search</button>
                            </form>

                        {%- else %}

                            <form action="{{ pathto('search') }}" class="navbar-form navbar-right" method="get" onsubmit="if (this.quicksearch.value == '')
                          { alert('Please enter one or more search terms first.');
                            return false; } return true;">

                                <div class="input-group" style="margin-top:2px;">
                                    <span class="input-group-addon" style="background:#61597b;color:#FFF;border:0px;" id="basic-addon1"><i class="fa fa-search" aria-hidden="true"></i></span>
                                    <input class="form-control" style="height:30px;border:0px;background:#61597b;color:#FFF;padding-left:0px;box-shadow: none;" type="text" id="quicksearch_top" name="q" title="Quick Search" placeholder="Quick Search" value="">
                                </div>
                                <button class="btn btn-default hidden" type="submit" value="Search" id="find_top">Search</button>
                            </form>

                        {%- endif %}

                    </div>
                </div>
            </div>
        </nav>
    </header>
{% endblock %}

{%- block content %}

    <div class="container">
        {%- block document %}
            <div class="row">

                {% if theme_sidebar == "left" %}
                    <div class="col-md-3 hidden-sm hidden-xs" role="main">
                        {{- sidebar() }}
                    </div>
                {%- endif %}

                <div class="col-md-9 col-sm-12 col-xs-12" role="main">

                    {% if theme_navigationlinks_top %}
                        {{- navlinks(theme_navigationlinks_top) }}
                    {% endif %}

                    {% block body %} {% endblock %}

                    {% if theme_navigationlinks_bottom %}
                        {{- navlinks(theme_navigationlinks_bottom) }}
                    {% endif %}

                </div>

                {% if theme_sidebar == "right" %}
                    <div class="col-md-3 hidden-sm hidden-xs" role="main">
                        {{- sidebar() }}
                    </div>
                {%- endif %}

            </div>
        {%- endblock %}
        <div class="clearer"></div>
    </div>
{%- endblock %}

{%- block footer %}
    <footer>
        <div class="container">
            <div class="row">
                <div class="col-xs-12 col-md-offset-2 col-md-7">
                    <h3 class="footerhead">{{ docstitle|replace("documentation","") }}</h3>
                    <div class="row">
                        <div class="col-xs-12 col-md-4">
                            <span class="kk-group-header">Powered by</span><br><span><a href="http://sphinx-doc.org/">Sphinx {{ sphinx_version }}</a> &amp; <a href="https://github.com/mmagorsc/tyrian_sphinx_theme">Tyrian Theme {{ tyrian_version }}</a></span>
                        </div>
                        <div class="col-xs-12 col-md-4">
                        </div>
                        <div class="col-xs-12 col-md-4">
                        </div>
                    </div>
                </div>
                <div class="col-xs-12 col-md-3">
                    <h3 class="footerhead">Questions or comments?</h3>
                    Please feel free to <a href="https://www.gentoo.org/inside-gentoo/contact/">contact us</a>.
                </div>
            </div>
            <div class="row">
                <div class="col-xs-2 col-sm-3 col-md-2">
                    <ul class="footerlinks three-icons">
                        <li><a href="https://twitter.com/gentoo" title="@Gentoo on Twitter"><span class="fa fa-twitter fa-fw"></span></a></li>
                        <li><a href="https://plus.google.com/+Gentoo" title="+Gentoo on Google+"><span class="fa fa-google-plus fa-fw"></span></a></li>
                        <li><a href="https://www.facebook.com/gentoo.org" title="Gentoo on Facebook"><span class="fa fa-facebook fa-fw"></span></a></li>
                    </ul>
                </div>
                <div class="col-xs-10 col-sm-9 col-md-10">
                    <strong>© 2001–2020 Gentoo Foundation, Inc.</strong><br>
                    <small>
                        Gentoo is a trademark of the Gentoo Foundation, Inc.
                        The contents of this document, unless otherwise expressly stated, are licensed under the
                        <a href="https://creativecommons.org/licenses/by-sa/3.0/" rel="license">CC-BY-SA-3.0</a> license.
                        The <a href="https://www.gentoo.org/inside-gentoo/foundation/name-logo-guidelines.html">Gentoo Name and Logo Usage Guidelines</a> apply.
                    </small>
                </div>
            </div>
        </div>
    </footer>

    <script src="https://assets.gentoo.org/tyrian/bootstrap.min.js"></script>

    {%- if pagename == "index" %}

        <div id="custom_toc">

            {%- if builder == "singlehtml" %}
                <span style="border-bottom: 1px solid #e1e1e1;font-weight: bold;">Contents</span>
                [<a class="" id="show_contents" role="button" data-toggle="collapse" href="#collapseExample" aria-expanded="false" aria-controls="collapseExample">show</a>]
            {%- else %}
                <h2 style="margin-top:20px!important;">Contents</h2>
            {%- endif %}
            <div class="collapse" id="collapseExample" style="margin-top:10px;">
                {%- if builder == "singlehtml" %}
                    {{ toc }}
                {%- endif %}
            </div>

        </div>

        <script type="text/javascript">
            $("#custom_toc").prependTo(".toctree-wrapper");
            $("#custom_toc").css("display", "inline-block");

            $('#collapseExample').on('show.bs.collapse', function () {
                $("#show_contents").html("hide");
            })

            $('#collapseExample').on('hide.bs.collapse', function () {
                $("#show_contents").html("show");
            })

            $("#collapseExample").collapse('show');

            {%- if builder == "singlehtml" %}
            $("#show_contents").html("hide");
            {%- endif %}

            {%- if builder != "singlehtml" %}
                $(".caption").next().detach().appendTo('#collapseExample');
                $(".caption").hide();
            {%- endif %}

        </script>
    {%- endif %}


    <script type="text/javascript">
        $('body').scrollspy({
            target: '.bs-docs-sidebar',
            offset: 40
        });
    </script>


    <script type="text/javascript">
        $('#indices-and-tables').hide()
    </script>



    {% if theme_analytics_id %}
    <script type="text/javascript">

        var _gaq = _gaq || [];
        _gaq.push(['_setAccount', '{{ theme_analytics_id }}']);
        _gaq.push(['_setDomainName', 'none']);
        _gaq.push(['_setAllowLinker', true]);
        _gaq.push(['_trackPageview']);

        (function() {
            var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
            ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
            var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
        })();

    </script>
    {% endif %}
{%- endblock %}



  </body>
</html>