-
Notifications
You must be signed in to change notification settings - Fork 236
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
51 changed files
with
2,509 additions
and
1,236 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| """Sphinx ReadTheDocs theme. | ||
| From https://github.com/ryan-roemer/sphinx-bootstrap-theme. | ||
| """ | ||
| import os | ||
|
|
||
| VERSION = (0, 1, 6) | ||
|
|
||
| __version__ = ".".join(str(v) for v in VERSION) | ||
| __version_full__ = __version__ | ||
|
|
||
|
|
||
| def get_html_theme_path(): | ||
| """Return list of HTML theme paths.""" | ||
| cur_dir = os.path.abspath(os.path.dirname(os.path.dirname(__file__))) | ||
| return cur_dir |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| <div role="navigation" aria-label="breadcrumbs navigation"> | ||
| <ul class="wy-breadcrumbs"> | ||
| <li><a href="{{ pathto(master_doc) }}">Docs</a> »</li> | ||
| {% for doc in parents %} | ||
| <li><a href="{{ doc.link|e }}">{{ doc.title }}</a> »</li> | ||
| {% endfor %} | ||
| <li>{{ title }}</li> | ||
| <li class="wy-breadcrumbs-aside"> | ||
| {% if display_github %} | ||
| <a href="https://github.com/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}.rst" class="fa fa-github"> Edit on GitHub</a> | ||
| {% elif display_bitbucket %} | ||
| <a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}.rst" class="fa fa-bitbucket"> Edit on Bitbucket</a> | ||
| {% elif show_source and has_source and sourcename %} | ||
| <a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> View page source</a> | ||
| {% endif %} | ||
| </li> | ||
| </ul> | ||
| <hr/> | ||
| </div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| <footer> | ||
| {% if next or prev %} | ||
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
| {% if next %} | ||
| <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}"/>Next <span class="fa fa-arrow-circle-right"></span></a> | ||
| {% endif %} | ||
| {% if prev %} | ||
| <a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}"><span class="fa fa-arrow-circle-left"></span> Previous</a> | ||
| {% endif %} | ||
| </div> | ||
| {% endif %} | ||
|
|
||
| <hr/> | ||
|
|
||
| <div role="contentinfo"> | ||
| <p> | ||
| {%- if show_copyright %} | ||
| {%- if hasdoc('copyright') %} | ||
| {% trans path=pathto('copyright'), copyright=copyright|e %}© <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %} | ||
| {%- else %} | ||
| {% trans copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %} | ||
| {%- endif %} | ||
| {%- endif %} | ||
|
|
||
| {%- if last_updated %} | ||
| {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %} | ||
| {%- endif %} | ||
| </p> | ||
| </div> | ||
|
|
||
| {% trans %}<a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %} | ||
| </footer> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| {# TEMPLATE VAR SETTINGS #} | ||
| {%- set url_root = pathto('', 1) %} | ||
| {%- if url_root == '#' %}{% set url_root = '' %}{% endif %} | ||
| {%- if not embedded and docstitle %} | ||
| {%- set titlesuffix = " — "|safe + docstitle|e %} | ||
| {%- else %} | ||
| {%- set titlesuffix = "" %} | ||
| {%- endif %} | ||
|
|
||
| <!DOCTYPE html> | ||
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> | ||
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| {% block htmltitle %} | ||
| <title>{{ title|striptags|e }}{{ titlesuffix }}</title> | ||
| {% endblock %} | ||
|
|
||
| {# FAVICON #} | ||
| {% if favicon %} | ||
| <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/> | ||
| {% endif %} | ||
|
|
||
| {# CSS #} | ||
| <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'> | ||
|
|
||
| {# OPENSEARCH #} | ||
| {% if not embedded %} | ||
| {% 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 %} | ||
|
|
||
| {% endif %} | ||
|
|
||
| {# RTD hosts this file, so just load on non RTD builds #} | ||
| {% if not READTHEDOCS %} | ||
| <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" /> | ||
| {% endif %} | ||
|
|
||
| {% for cssfile in css_files %} | ||
| <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" /> | ||
| {% endfor %} | ||
|
|
||
| {%- 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 %} | ||
| <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}"/> | ||
| {%- if parents %} | ||
| <link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}"/> | ||
| {%- 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 %} | ||
|
|
||
| {# Keep modernizr in head - http://modernizr.com/docs/#installing #} | ||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script> | ||
|
|
||
| </head> | ||
|
|
||
| <body class="wy-body-for-nav" role="document"> | ||
|
|
||
| <div class="wy-grid-for-nav"> | ||
|
|
||
| {# SIDE NAV, TOGGLES ON MOBILE #} | ||
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> | ||
| <div class="wy-side-nav-search"> | ||
| <a href="{{ pathto(master_doc) }}" class="fa fa-home"> {{ project }}</a> | ||
| {% include "searchbox.html" %} | ||
| </div> | ||
|
|
||
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> | ||
| {% set toctree = toctree(maxdepth=2, collapse=False, includehidden=True) %} | ||
| {% if toctree %} | ||
| {{ toctree }} | ||
| {% else %} | ||
| <!-- Local TOC --> | ||
| <div class="local-toc">{{ toc }}</div> | ||
| {% endif %} | ||
| </div> | ||
| | ||
| </nav> | ||
|
|
||
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
|
|
||
| {# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #} | ||
| <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| <a href="{{ pathto(master_doc) }}">{{ project }}</a> | ||
| </nav> | ||
|
|
||
|
|
||
| {# PAGE CONTENT #} | ||
| <div class="wy-nav-content"> | ||
| <div class="rst-content"> | ||
| {% include "breadcrumbs.html" %} | ||
| <div role="main"> | ||
| {% block body %}{% endblock %} | ||
| </div> | ||
| {% include "footer.html" %} | ||
| </div> | ||
| </div> | ||
|
|
||
| </section> | ||
|
|
||
| </div> | ||
| {% include "versions.html" %} | ||
|
|
||
| {% if not embedded %} | ||
|
|
||
| <script type="text/javascript"> | ||
| var DOCUMENTATION_OPTIONS = { | ||
| URL_ROOT:'{{ url_root }}', | ||
| VERSION:'{{ release|e }}', | ||
| COLLAPSE_INDEX:false, | ||
| FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}', | ||
| HAS_SOURCE: {{ has_source|lower }} | ||
| }; | ||
| </script> | ||
| {%- for scriptfile in script_files %} | ||
| <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script> | ||
| {%- endfor %} | ||
|
|
||
| {% endif %} | ||
|
|
||
| {# RTD hosts this file, so just load on non RTD builds #} | ||
| {% if not READTHEDOCS %} | ||
| <script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script> | ||
| {% endif %} | ||
|
|
||
| {# STICKY NAVIGATION #} | ||
| {% if theme_sticky_navigation %} | ||
| <script type="text/javascript"> | ||
| jQuery(function () { | ||
| SphinxRtdTheme.StickyNav.enable(); | ||
| }); | ||
| </script> | ||
| {% endif %} | ||
|
|
||
| {%- block footer %} {% endblock %} | ||
|
|
||
| </body> | ||
| </html> |
Oops, something went wrong.