Skip to content

Commit c69a8de

Browse files
tomchristietomchristie
committed
Copy 'readthedocs' theme from 'mkdocs' package.
0 parents  commit c69a8de

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+4980
-0
lines changed

‎readthedocs/404.html

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{% extends "base.html" %}
2+
3+
{% block content %}
4+
5+
<h1 id="404-page-not-found">404</h1>
6+
7+
<p><strong>{% trans %}Page not found{% endtrans %}</strong></p>
8+
9+
{% endblock %}

‎readthedocs/__init__.py

Whitespace-only changes.

‎readthedocs/base.html

Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
1+
<!DOCTYPE html>
2+
<html class="writer-html5" lang="{{ config.theme.locale|default('en') }}" >
3+
<head>
4+
{%- block site_meta %}
5+
<meta charset="utf-8" />
6+
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8+
{%- if page and page.is_homepage %}<meta name="description" content="{{ config.site_description }}" />{%- endif %}
9+
{%- if config.site_author %}<meta name="author" content="{{ config.site_author }}" />{%- endif %}
10+
{%- if page and page.canonical_url %}<link rel="canonical" href="{{ page.canonical_url }}" />{%- endif %}
11+
{%- if config.site_favicon %}
12+
<link rel="shortcut icon" href="{{ config.site_favicon|url }}" />
13+
{%- else %}
14+
<link rel="shortcut icon" href="{{ 'img/favicon.ico'|url }}" />
15+
{%- endif %}
16+
{%- endblock %}
17+
18+
{%- block htmltitle %}
19+
<title>{% if page and page.title and not page.is_homepage %}{{ page.title }} - {% endif %}{{ config.site_name }}</title>
20+
{%- endblock %}
21+
22+
{%- block styles %}
23+
<link rel="stylesheet" href="{{ 'css/theme.css'|url }}" />
24+
<link rel="stylesheet" href="{{ 'css/theme_extra.css'|url }}" />
25+
{%- if config.theme.highlightjs %}
26+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/{{ config.theme.hljs_style }}.min.css" />
27+
{%- endif %}
28+
{%- for path in config.extra_css %}
29+
<link href="{{ path|url }}" rel="stylesheet" />
30+
{%- endfor %}
31+
{%- endblock %}
32+
33+
{%- block libs %}
34+
{% if page %}
35+
<script>
36+
// Current page data
37+
var mkdocs_page_name = {{ page.title|tojson }};
38+
var mkdocs_page_input_path = {{ page.file.src_path|string|tojson }};
39+
var mkdocs_page_url = {{ page.abs_url|tojson }};
40+
</script>
41+
{% endif %}
42+
<!--[if lt IE 9]>
43+
<script src="{{ 'js/html5shiv.min.js'|url }}"></script>
44+
<![endif]-->
45+
{%- if config.theme.highlightjs %}
46+
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
47+
{%- for lang in config.theme.hljs_languages %}
48+
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/languages/{{lang}}.min.js"></script>
49+
{%- endfor %}
50+
<script>hljs.highlightAll();</script>
51+
{%- endif %}
52+
{%- endblock %}
53+
54+
{%- block extrahead %} {% endblock %}
55+
56+
{%- block analytics %}
57+
{%- if config.theme.analytics.gtag %}
58+
<script async src="https://www.googletagmanager.com/gtag/js?id={{ config.theme.analytics.gtag }}"></script>
59+
<script>
60+
window.dataLayer = window.dataLayer || [];
61+
function gtag(){dataLayer.push(arguments);}
62+
gtag('js', new Date());
63+
64+
gtag('config', {{ config.theme.analytics.gtag|tojson }}{%- if config.theme.analytics.anonymize_ip %}, {'anonymize_ip': true}{%- endif %});
65+
</script>
66+
{%- elif config.google_analytics %}
67+
<script>
68+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
69+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
70+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
71+
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
72+
73+
ga('create', {{ config.google_analytics[0]|tojson }}, {{ config.google_analytics[1]|tojson }});
74+
{%- if config.theme.analytics.anonymize_ip %}ga('set', 'anonymizeIp', true);{%- endif %}
75+
ga('send', 'pageview');
76+
</script>
77+
{% endif %}
78+
{%- endblock %}
79+
</head>
80+
81+
<body class="wy-body-for-nav" role="document">
82+
83+
<div class="wy-grid-for-nav">
84+
85+
{#- SIDE NAV, TOGGLES ON MOBILE #}
86+
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
87+
<div class="wy-side-scroll">
88+
<div class="wy-side-nav-search">
89+
{%- block site_name %}
90+
{%- if config.theme.logo %}
91+
<a href="{{ nav.homepage.url|url }}">
92+
{%- else %}
93+
<a href="{{ nav.homepage.url|url }}" class="icon icon-home"> {{ config.site_name }}
94+
{%- endif %}
95+
{%- if config.theme.logo %}
96+
<img src="{{ config.theme.logo|url }}" class="logo" alt="{% trans %}Logo{% endtrans %}"/>
97+
{%- endif %}
98+
</a>
99+
{%- endblock %}
100+
{%- if config.extra.version %}
101+
<div class="version">
102+
{{ config.extra.version }}
103+
</div>
104+
{%- endif %}
105+
{%- block search_button %}
106+
{%- if 'search' in config.plugins %}{%- include "searchbox.html" %}{%- endif %}
107+
{%- endblock %}
108+
</div>
109+
110+
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="{% trans %}Navigation menu{% endtrans %}">
111+
{%- block site_nav %}
112+
{%- set navlevel = 1 %}
113+
{%- for nav_item in nav %}
114+
{%- if nav_item.is_section %}
115+
{%- if nav_item.is_page %}
116+
<ul><li{% if nav_item == page %} class="current-section"{% endif %}>
117+
<a href="{% if nav_item == page %}#{% else %}{{ nav_item.url|url }}{% endif %}" style="padding: 0; font-size: inherit; line-height: inherit">
118+
{%- endif %}
119+
<p class="caption"><span class="caption-text">{{ nav_item.title }}</span></p>
120+
{%- if nav_item.is_page %}
121+
</a>
122+
</li></ul>
123+
{%- endif %}
124+
<ul{% if nav_item.active %} class="current"{% endif %}>
125+
{%- for nav_item in nav_item.children %}
126+
<li class="toctree-l{{ navlevel }}{% if nav_item.active %} current{% endif %}">
127+
{%- include 'nav.html' %}
128+
</li>
129+
{%- endfor %}
130+
</ul>
131+
{%- elif config.theme.include_homepage_in_sidebar or (not nav_item == nav.homepage) %}
132+
<ul{% if nav_item.active %} class="current"{% endif %}>
133+
<li class="toctree-l{{ navlevel }}{% if nav_item.active %} current{% endif %}">
134+
{%- include 'nav.html' %}
135+
</li>
136+
</ul>
137+
{%- endif %}
138+
{%- endfor %}
139+
{%- endblock %}
140+
</div>
141+
</div>
142+
</nav>
143+
144+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
145+
146+
{#- MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
147+
<nav class="wy-nav-top" role="navigation" aria-label="{% trans %}Mobile navigation menu{% endtrans %}">
148+
{%- block mobile_nav %}
149+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
150+
<a href="{{ nav.homepage.url|url }}">{{ config.site_name }}</a>
151+
{% endblock %}
152+
</nav>
153+
154+
{#- PAGE CONTENT #}
155+
<div class="wy-nav-content">
156+
<div class="rst-content">
157+
{%- include "breadcrumbs.html" %}
158+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
159+
<div class="section" itemprop="articleBody">
160+
{% block content %}
161+
{{ page.content }}
162+
{% endblock %}
163+
</div>
164+
</div>
165+
{%- block footer %}
166+
{%- include "footer.html" %}
167+
{% endblock %}
168+
</div>
169+
</div>
170+
171+
</section>
172+
173+
</div>
174+
175+
{% include "versions.html" -%}
176+
177+
{%- block scripts %}
178+
<script src="{{ 'js/jquery-3.6.0.min.js'|url }}"></script>
179+
<script>var base_url = {{ base_url|tojson }};</script>
180+
<script src="{{ 'js/theme_extra.js'|url }}"></script>
181+
<script src="{{ 'js/theme.js'|url }}"></script>
182+
{%- for script in config.extra_javascript %}
183+
{{ script|script_tag }}
184+
{%- endfor %}
185+
<script>
186+
jQuery(function () {
187+
SphinxRtdTheme.Navigation.enable({{ 'true' if config.theme.sticky_navigation else 'false' }});
188+
});
189+
</script>
190+
{%- endblock %}
191+
192+
</body>
193+
</html>
194+
{% if page and page.is_homepage %}
195+
<!--
196+
MkDocs version : {{ mkdocs_version }}
197+
Build Date UTC : {{ build_date_utc }}
198+
-->
199+
{% endif %}

‎readthedocs/breadcrumbs.html

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<div role="navigation" aria-label="breadcrumbs navigation">
2+
<ul class="wy-breadcrumbs">
3+
<li><a href="{{ nav.homepage.url|url }}" class="icon icon-home" aria-label="{% trans %}Docs{% endtrans %}"></a></li>
4+
{%- if page %}
5+
{%- for doc in page.ancestors[::-1] %}
6+
{%- if doc.url %}
7+
<li class="breadcrumb-item"><a href="{{ doc.url|url }}">{{ doc.title }}</a></li>
8+
{%- else %}
9+
<li class="breadcrumb-item">{{ doc.title }}</li>
10+
{%- endif %}
11+
{%- endfor %}
12+
<li class="breadcrumb-item active">{{ page.title }}</li>
13+
{%- endif %}
14+
<li class="wy-breadcrumbs-aside">
15+
{%- block repo %}
16+
{%- if page and page.edit_url %}
17+
{%- if config.repo_name|lower == 'github' %}
18+
<a href="{{ page.edit_url }}" class="icon icon-github"> {% trans repo_name=config.repo_name %}Edit on {{ repo_name }}{% endtrans %}</a>
19+
{%- elif config.repo_name|lower == 'bitbucket' %}
20+
<a href="{{ page.edit_url }}" class="icon icon-bitbucket"> {% trans repo_name=config.repo_name %}Edit on {{ repo_name }}{% endtrans %}</a>
21+
{%- elif config.repo_name|lower == 'gitlab' %}
22+
<a href="{{ page.edit_url }}" class="icon icon-gitlab"> {% trans repo_name=config.repo_name %}Edit on {{ repo_name }}{% endtrans %}</a>
23+
{%- elif config.repo_name %}
24+
<a href="{{ page.edit_url }}">{% trans repo_name=config.repo_name %}Edit on {{ repo_name }}{% endtrans %}</a>
25+
{%- else %}
26+
<a href="{{ page.edit_url }}">{% trans %}Edit{% endtrans %}</a>
27+
{%- endif %}
28+
{%- endif %}
29+
{%- endblock %}
30+
</li>
31+
</ul>
32+
{%- if config.theme.prev_next_buttons_location|lower in ['top', 'both']
33+
and page and (page.next_page or page.previous_page) %}
34+
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="{% trans %}Breadcrumb Navigation{% endtrans %}">
35+
{%- if page.previous_page %}
36+
<a href="{{ page.previous_page.url|url }}" class="btn btn-neutral float-left" title="{{ page.previous_page.title }}"><span class="icon icon-circle-arrow-left" aria-hidden="true"></span> {% trans %}Previous{% endtrans %}</a>
37+
{%- endif %}
38+
{%- if page.next_page %}
39+
<a href="{{ page.next_page.url|url }}" class="btn btn-neutral float-right" title="{{ page.next_page.title }}">{% trans %}Next{% endtrans %} <span class="icon icon-circle-arrow-right" aria-hidden="true"></span></a>
40+
{%- endif %}
41+
</div>
42+
{%- endif %}
43+
<hr/>
44+
</div>

‎readthedocs/css/fonts/Roboto-Slab-Bold.woff

85.6 KB
Binary file not shown.

‎readthedocs/css/fonts/Roboto-Slab-Bold.woff2

65.7 KB
Binary file not shown.

‎readthedocs/css/fonts/Roboto-Slab-Regular.woff

84.3 KB
Binary file not shown.

‎readthedocs/css/fonts/Roboto-Slab-Regular.woff2

64.9 KB
Binary file not shown.

‎readthedocs/css/fonts/fontawesome-webfont.eot

162 KB
Binary file not shown.

0 commit comments

Comments
 (0)