8000 Update layout.html for sphinx themes · alexrudy/matplotlib@1e2fded · GitHub
[go: up one dir, main page]

Skip to content

Commit 1e2fded

Browse files
committed
Update layout.html for sphinx themes
1 parent 359cad3 commit 1e2fded

File tree

1 file changed

+37
-227
lines changed

1 file changed

+37
-227
lines changed

doc/_templates/layout.html

Lines changed: 37 additions & 227 deletions
Original file line numberDiff line numberDiff line change
@@ -1,164 +1,28 @@
1-
{#
2-
basic/layout.html
3-
~~~~~~~~~~~~~~~~~
4-
5-
Master layout template for Sphinx themes.
6-
7-
:copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
8-
:license: BSD, see LICENSE for details.
9-
#}
10-
{%- block doctype -%}
11-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
12-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
13-
{%- endblock %}
14-
{%- set reldelim1 = reldelim1 is not defined and ' &raquo;' or reldelim1 %}
15-
{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %}
16-
{%- set render_sidebar = (not embedded) and (not theme_nosidebar|tobool) and
17-
(sidebars != []) %}
18-
{%- set url_root = pathto('', 1) %}
19-
{# XXX necessary? #}
20-
{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
21-
{%- if not embedded and docstitle %}
22-
{%- set titlesuffix = " &mdash; "|safe + docstitle|e %}
23-
{%- else %}
24-
{%- set titlesuffix = "" %}
25-
{%- endif %}
26-
27-
{%- macro relbar() %}
28-
<div class="related">
29-
<h3>{{ _('Navigation') }}</h3>
30-
<ul>
31-
{%- for rellink in rellinks %}
32-
<li class="right" {% if loop.first %}style="margin-right: 10px"{%
33-
endif %}>
34-
<a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags|e
35-
}}"
36-
{{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>
37-
{%- if not loop.first %}{{ reldelim2 }}{% endif %}</li>
38-
{%- endfor %}
1+
{% extends "!layout.html" %}
392

3+
{%- block rootrellink %}
404
<li><a href="{{ pathto('index') }}">home</a>|&nbsp;</li>
415
<li><a href="{{ pathto('gallery/index') }}">examples</a>|&nbsp;</li>
426
<li><a href="{{ pathto('tutorials/index') }}">tutorials</a>|&nbsp;</li>
437
<li><a href="{{ pathto('api/index') }}">API</a>|&nbsp;</li>
448
<li><a href="{{ pathto('contents') }}">contents</a> &raquo;</li>
9+
{%- endblock %}
4510

46-
{%- for parent in parents %}
47-
<li><a href="{{ parent.link|e }}" {% if loop.last %}{{
48-
accesskey("U") }}{% endif %}>{{ parent.title }}</a>{{ reldelim1 }}</li>
49-
{%- endfor %}
50-
{%- block relbaritems %} {% endblock %}
51-
</ul>
52-
</div>
53-
{%- endmacro %}
54-
55-
{%- macro sidebar() %}
56-
{%- if render_sidebar %}
57-
<div class="sphinxsidebar">
58-
<div class="sphinxsidebarwrapper">
59-
{%- block sidebarlogo %}
60-
{%- if logo %}
61-
<p class="logo"><a href="{{ pathto(master_doc) }}">
62-
<img class="logo" src="{{ pathto('_static/' + logo, 1) }}"
63-
alt="Logo"/>
64-
</a></p>
65-
{%- endif %}
66-
{%- endblock %}
67-
{%- if sidebars != None %}
68-
{#- new style sidebar: explicitly include/exclude templates #}
69-
{%- for sidebartemplate in sidebars %}
70-
{%- include sidebartemplate %}
71-
{%- endfor %}
72-
{%- endif %}
73-
</div>
74-
</div>
75-
{%- endif %}
76-
{%- endmacro %}
77-
78-
{%- macro script() %}
79-
<script type="text/javascript" id="documentation_options" data-url_root="{{ pathto('', 1) }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
80-
{%- for scriptfile in script_files %}
81-
{{ js_tag(scriptfile) }}
82-
{%- endfor %}
83-
{%- endmacro %}
84-
85-
{%- macro css() %}
86-
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}"
87-
type="text/css" />
88-
<link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}"
89-
type="text/css" />
90-
{%- for cssfile in css_files %}
91-
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
92-
{%- endfor %}
93-
{%- endmacro %}
11+
{%- block relbar1 %}{{ relbar() }}{% endblock %}
12+
{%- block relbar2 %}{% endblock %}
9413

95-
<html xmlns="http://www.w3.org/1999/xhtml">
96-
<head>
97-
<meta http-equiv="Content-Type" content="text/html; charset={{ encoding
98-
}}" />
99-
{{ metatags }}
100-
{%- block htmltitle %}
101-
<title>{{ title|striptags|e }}{{ titlesuffix }}</title>
102-
{%- endblock %}
103-
{{ css() }}
104-
{%- if not embedded %}
105-
{{ script() }}
106-
{%- if use_opensearch %}
107-
<link rel="search" type="application/opensearchdescription+xml"
108-
title="{% trans docstitle=docstitle|e %}Search within {{ docstitle
109-
}}{% endtrans %}"
110-
href="{{ pathto('_static/opensearch.xml', 1) }}"/>
111-
{%- endif %}
112-
{%- if favicon %}
113-
<link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
114-
{%- endif %}
115-
{%- endif %}
11614
{%- block linktags %}
117-
{%- if hasdoc('about') %}
118-
<link rel="author" title="{{ _('About these documents') }}" href="{{
119-
pathto('about') }}" />
120-
{%- endif %}
121-
{%- if hasdoc('genindex') %}
122-
<link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}"
123-
/>
124-
{%- endif %}
125-
{%- if hasdoc('search') %}
126-
<link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}"
127-
/>
128-
{%- endif %}
129-
{%- if hasdoc('copyright') %}
130-
<link rel="copyright" title="{{ _('Copyright') }}" href="{{
131-
pathto('copyright') }}" />
132-
{%- endif %}
133-
<link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}" />
134-
{%- if parents %}
135-
<link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{
136-
parents[-1].link|e }}" />
137-
{%- endif %}
138-
{%- if next %}
139-
<link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e
140-
}}" />
141-
{%- endif %}
142-
{%- if prev %}
143-
<link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e
144-
}}" />
145-
{%- endif %}
146-
{%- endblock %}
147-
{%- block extrahead %}
15+
{{ super() }}
16+
<link rel="top" title="{{ docstitle }}" href="#" />
14817
{%- if '+' in release %}
14918
<link rel="canonical" href="https://matplotlib.org/devdocs/{{pagename}}.html" />
15019
{%- else %}
15120
<link rel="canonical" href="https://matplotlib.org/{{version}}/{{pagename}}.html" />
15221
{%- endif %}
153-
{% endblock %}
154-
155-
156-
</head>
157-
<body>
158-
{%- block header %}{% endblock %}
159-
160-
{% block relbar1 %}
22+
{%- endblock %}
16123

24+
{%- block header %}
25+
{{super()}}
16226
{%- if '+' in release %}
16327
<div id="unreleased-message">
16428
You are reading documentation for the unreleased version of Matplotlib.
@@ -167,91 +31,37 @@ <h3>{{ _('Navigation') }}</h3>
16731
</a>
16832
</div>
16933
{%- endif %}
170-
17134
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
172-
{%- if builder in ('htmlhelp', 'devhelp', 'latex') %}
173-
<a href="{{ pathto('index') }}">
174-
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version {{ version|e }}</span></div>
175-
<img src="{{pathto("_static/logo2.png", 1) }}" height="125px" border="0" alt="matplotlib"/></a>
176-
{%- else %}
177-
<a href="{{ pathto('index') }}">
178-
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version {{ version|e }}</span></div>
179-
<img src="{{pathto("_static/logo2.png", 1) }}" height="125px" border="0" alt="matplotlib"/></a>
180-
{%- endif %}
181-
182-
<!-- The "Fork me on github" ribbon -->
183-
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
184-
</div>
185-
186-
{% endblock %}
187-
188-
{%- block relbar2 %}
189-
190-
{{ relbar() }}
191-
192-
{% endblock %}
193-
194-
195-
196-
{%- block content %}
197-
{%- block sidebar1 %} {# possible location for sidebar #} {% endblock %}
198-
199-
{%- block sidebar2 %}{{ sidebar() }}{% endblock %}
200-
<div class="document">
201-
{%- block document %}
202-
<div class="documentwrapper">
203-
{%- if render_sidebar %}
204-
<div class="bodywrapper">
205-
{%- endif %}
206-
<div class="body">
207-
{% block body %} {% endblock %}
208-
</div>
209-
{%- if render_sidebar %}
210-
</div>
211-
{%- endif %}
212-
</div>
213-
{%- endblock %}
214-
215-
<div class="clearer"></div>
216-
</div>
217-
{%- endblock %}
218-
219-
{%- block footer %}
220-
<div class="footer">
221-
{%- if show_copyright %}
222-
{%- if hasdoc('copyright') %}
223-
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a
224-
href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
225-
{%- else %}
226-
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{%
227-
endtrans %}
228-
{%- endif %}
229-
{%- endif %}
230-
<br />
231-
{%- if last_updated %}
232-
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
233-
{%- endif %}
234-
{%- if show_sphinx %}
235-
{% trans sphinx_version=sphinx_version|e %}Created using
236-
<a href="http://sphinx-doc.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
237-
{%- endif %}
238-
{%- if sha %}
239-
Doc version {{ sha }}.
35+
{%- if builder in ('htmlhelp', 'devhelp', 'latex') %}
36+
<a href="{{ pathto('index') }}">
37+
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version {{ version|e }}</span></div>
38+
<img src="{{pathto("_static/logo2.png", 1) }}" height="125px" border="0" alt="matplotlib"/></a>
39+
{%- else %}
40+
<a href="{{ pathto('index') }}">
41+
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version {{ version|e }}</span></div>
42+
<img src="{{pathto("_static/logo2.png", 1) }}" height="125px" border="0" alt="matplotlib"/></a>
24043
{%- endif %}
44+
45+
<!-- The "Fork me on github" ribbon -->
46+
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
24147
</div>
242-
{%- endblock %}
243-
244-
<script>
245-
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
246-
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
247-
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
248-
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
48+
{%- endblock %}
24949

250-
ga('create', 'UA-55954603-1', 'auto');
251-
ga('send', 'pageview');
50+
{%- block sidebar1 %}{{ sidebar() }}{% endblock %}
51+
{%- block sidebar2 %}{% endblock %}
25252

253-
</script>
254-
</body>
53+
{%- block footer %}
25554
<footer>
55+
{{super()}}
25656
</footer>
257-
</html>
57+
<script>
58+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=< 71EF /span>i[r]||function(){
59+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
60+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
61+
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
62+
63+
ga('create', 'UA-55954603-1', 'auto');
64+
ga('send', 'pageview');
65+
66+
</script>
67+
{%- endblock %}

0 commit comments

Comments
 (0)
0