Skip to content

Commit 43d6564

Browse files
2 parents 362b301 + 638cc97 commit 43d6564

Some content is hidden

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

43 files changed

+2305
-9
lines changed

docs/_static/logo.png

8.5 KB
Loading

docs/_themes/eclipse-help/__init__.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
"""Sphinx ReadTheDocs theme.
2+
3+
From https://github.com/ryan-roemer/sphinx-bootstrap-theme.
4+
5+
"""
6+
import os
7+
8+
__version__ = '0.2.4'
9+
__version_full__ = __version__
10+
11+
12+
def get_html_theme_path():
13+
"""Return list of HTML theme paths."""
14+
cur_dir = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
15+
return cur_dir
776 Bytes
Binary file not shown.
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
{# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #}
2+
3+
{% if page_source_suffix %}
4+
{% set suffix = page_source_suffix %}
5+
{% else %}
6+
{% set suffix = source_suffix %}
7+
{% endif %}
8+
9+
{% if meta is defined and meta is not none %}
10+
{% set check_meta = True %}
11+
{% else %}
12+
{% set check_meta = False %}
13+
{% endif %}
14+
15+
{% if check_meta and 'github_url' in meta %}
16+
{% set display_github = True %}
17+
{% endif %}
18+
19+
{% if check_meta and 'bitbucket_url' in meta %}
20+
{% set display_bitbucket = True %}
21+
{% endif %}
22+
23+
{% if check_meta and 'gitlab_url' in meta %}
24+
{% set display_gitlab = True %}
25+
{% endif %}
26+
27+
<div role="navigation" aria-label="breadcrumbs navigation">
28+
29+
<ul class="wy-breadcrumbs">
30+
{% block breadcrumbs %}
31+
<li><a href="{{ pathto(master_doc) }}">{{ _('Docs') }}</a> &raquo;</li>
32+
{% for doc in parents %}
33+
<li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
34+
{% endfor %}
35+
<li>{{ title }}</li>
36+
{% endblock %}
37+
{% block breadcrumbs_aside %}
38+
<li class="wy-breadcrumbs-aside">
39+
{% if pagename != "search" %}
40+
{% if display_github %}
41+
{% if check_meta and 'github_url' in meta %}
42+
<!-- User defined GitHub URL -->
43+
<a href="{{ meta['github_url'] }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
44+
{% else %}
45+
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
46+
{% endif %}
47+
{% elif display_bitbucket %}
48+
{% if check_meta and 'bitbucket_url' in meta %}
49+
<!-- User defined Bitbucket URL -->
50+
<a href="{{ meta['bitbucket_url'] }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
51+
{% else %}
52+
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
53+
{% endif %}
54+
{% elif display_gitlab %}
55+
{% if check_meta and 'gitlab_url' in meta %}
56+
<!-- User defined GitLab URL -->
57+
<a href="{{ meta['gitlab_url'] }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
58+
{% else %}
59+
<a href="https://{{ gitlab_host|default("gitlab.com") }}/{{ gitlab_user }}/{{ gitlab_repo }}/blob/{{ gitlab_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
60+
{% endif %}
61+
{% elif show_source and source_url_prefix %}
62+
<a href="{{ source_url_prefix }}{{ pagename }}{{ suffix }}">{{ _('View page source') }}</a>
63+
{% elif show_source and has_source and sourcename %}
64+
<a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> {{ _('View page source') }}</a>
65+
{% endif %}
66+
{% endif %}
67+
</li>
68+
{% endblock %}
69+
</ul>
70+
71+
{% if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
72+
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="breadcrumb navigation">
73+
{% if next %}
74+
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
75+
{% endif %}
76+
{% if prev %}
77+
<a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
78+
{% endif %}
79+
</div>
80+
{% endif %}
81+
<hr/>
82+
</div>

docs/_themes/eclipse-help/footer.html

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<footer>
2+
3+
<hr/>
4+
5+
<div role="contentinfo">
6+
<p>
7+
{%- if show_copyright %}
8+
{%- if hasdoc('copyright') %}
9+
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
10+
{%- else %}
11+
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
12+
{%- endif %}
13+
{%- endif %}
14+
15+
{%- if build_id and build_url %}
16+
{% trans build_url=build_url, build_id=build_id %}
17+
<span class="build">
18+
Build
19+
<a href="{{ build_url }}">{{ build_id }}</a>.
20+
</span>
21+
{% endtrans %}
22+
{%- elif commit %}
23+
{% trans commit=commit %}
24+
<span class="commit">
25+
Revision <code>{{ commit }}</code>.
26+
</span>
27+
{% endtrans %}
28+
{%- elif last_updated %}
29+
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
30+
{%- endif %}
31+
32+
</p>
33+
</div>
34+
35+
{%- if show_sphinx %}
36+
{% trans %}Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %}.
37+
{%- endif %}
38+
39+
{%- block extrafooter %} {% endblock %}
40+
41+
</footer>
42+

docs/_themes/eclipse-help/layout.html

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
{# TEMPLATE VAR SETTINGS #}
2+
{%- set url_root = pathto('', 1) %}
3+
{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
4+
{%- if not embedded and docstitle %}
5+
{%- set titlesuffix = " &mdash; "|safe + docstitle|e %}
6+
{%- else %}
7+
{%- set titlesuffix = "" %}
8+
{%- endif %}
9+
10+
<!DOCTYPE html>
11+
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
12+
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
13+
<head>
14+
<meta charset="utf-8">
15+
{{ metatags }}
16+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
17+
{% block htmltitle %}
18+
<title>{{ title|striptags|e }}{{ titlesuffix }}</title>
19+
{% endblock %}
20+
21+
{# FAVICON #}
22+
{% if favicon %}
23+
<link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
24+
{% endif %}
25+
{# CANONICAL URL #}
26+
{% if theme_canonical_url %}
27+
<link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
28+
{% endif %}
29+
30+
{# CSS #}
31+
32+
{# RTD hosts this file, so just load on non RTD builds #}
33+
{% if not READTHEDOCS %}
34+
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
35+
{% endif %}
36+
37+
{% for cssfile in css_files %}
38+
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
39+
{% endfor %}
40+
41+
<link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
42+
43+
44+
{% for cssfile in extra_css_files %}
45+
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
46+
{% endfor %}
47+
48+
49+
{%- block extrahead %} {% endblock %}
50+
51+
{# Keep modernizr in head - http://modernizr.com/docs/#installing #}
52+
<script src="{{ pathto('_static/js/modernizr.min.js', 1) }}"></script>
53+
54+
</head>
55+
56+
<body role="document" style="background:white;font-family: serif;color:black;">
57+
58+
{% block extrabody %} {% endblock %}
59+
60+
<section data-toggle="" class="">
61+
62+
63+
{# PAGE CONTENT #}
64+
<div class="" style="padding:1em">
65+
<div class="rst-content">
66+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
67+
<div itemprop="articleBody">
68+
{% block body %}{% endblock %}
69+
</div>
70+
<div class="articleComments">
71+
{% block comments %}{% endblock %}
72+
</div>
73+
</div>
74+
{% include "footer.html" %}
75+
</div>
76+
</div>
77+
78+
</section>
79+
80+
</div>
81+
{% include "versions.html" %}
82+
83+
{% if not embedded %}
84+
85+
<script type="text/javascript">
86+
var DOCUMENTATION_OPTIONS = {
87+
URL_ROOT:'{{ url_root }}',
88+
VERSION:'{{ release|e }}',
89+
COLLAPSE_INDEX:false,
90+
FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
91+
HAS_SOURCE: {{ has_source|lower }},
92+
SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
93+
};
94+
</script>
95+
{%- for scriptfile in script_files %}
96+
<script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
97+
{%- endfor %}
98+
99+
{% endif %}
100+
101+
{# RTD hosts this file, so just load on non RTD builds #}
102+
{% if not READTHEDOCS %}
103+
<script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script>
104+
{% endif %}
105+
106+
{%- block footer %} {% endblock %}
107+
108+
</body>
109+
</html>

0 commit comments

Comments
 (0)