doc: change sphinx theme to bootstrap for manager doc (#1646)
Maxime Besson
parent
72f957957a
commit
35bac32cd6
@ -1,82 +0,0 @@ |
||||
{# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #} |
||||
|
||||
{% if page_source_suffix %} |
||||
{% set suffix = page_source_suffix %} |
||||
{% else %} |
||||
{% set suffix = source_suffix %} |
||||
{% endif %} |
||||
|
||||
{% if meta is defined and meta is not none %} |
||||
{% set check_meta = True %} |
||||
{% else %} |
||||
{% set check_meta = False %} |
||||
{% endif %} |
||||
|
||||
{% if check_meta and 'github_url' in meta %} |
||||
{% set display_github = True %} |
||||
{% endif %} |
||||
|
||||
{% if check_meta and 'bitbucket_url' in meta %} |
||||
{% set display_bitbucket = True %} |
||||
{% endif %} |
||||
|
||||
{% if check_meta and 'gitlab_url' in meta %} |
||||
{% set display_gitlab = True %} |
||||
{% endif %} |
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation"> |
||||
|
||||
<ul class="wy-breadcrumbs"> |
||||
{% block 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> |
||||
{% endblock %} |
||||
{% block breadcrumbs_aside %} |
||||
<li class="wy-breadcrumbs-aside"> |
||||
{% if hasdoc(pagename) %} |
||||
{% if display_github %} |
||||
{% if check_meta and 'github_url' in meta %} |
||||
<!-- User defined GitHub URL --> |
||||
<a href="{{ meta['github_url'] }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a> |
||||
{% else %} |
||||
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a> |
||||
{% endif %} |
||||
{% elif display_bitbucket %} |
||||
{% if check_meta and 'bitbucket_url' in meta %} |
||||
<!-- User defined Bitbucket URL --> |
||||
<a href="{{ meta['bitbucket_url'] }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a> |
||||
{% else %} |
||||
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ suffix }}?mode={{ theme_vcs_pageview_mode|default("view") }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a> |
||||
{% endif %} |
||||
{% elif display_gitlab %} |
||||
{% if check_meta and 'gitlab_url' in meta %} |
||||
<!-- User defined GitLab URL --> |
||||
<a href="{{ meta['gitlab_url'] }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a> |
||||
{% else %} |
||||
<a href="https://{{ gitlab_host|default("gitlab.com") }}/{{ gitlab_user }}/{{ gitlab_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ gitlab_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a> |
||||
{% endif %} |
||||
{% elif show_source and source_url_prefix %} |
||||
<a href="{{ source_url_prefix }}{{ pagename }}{{ suffix }}">{{ _('View page source') }}</a> |
||||
{% elif show_source and has_source and sourcename %} |
||||
<a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> {{ _('View page source') }}</a> |
||||
{% endif %} |
||||
{% endif %} |
||||
</li> |
||||
{% endblock %} |
||||
</ul> |
||||
|
||||
{% if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %} |
||||
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="breadcrumb navigation"> |
||||
{% if next %} |
||||
<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> |
||||
{% endif %} |
||||
{% if prev %} |
||||
<a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
||||
{% endif %} |
||||
</div> |
||||
{% endif %} |
||||
<hr/> |
||||
</div> |
||||
@ -1,54 +0,0 @@ |
||||
<footer> |
||||
{% if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (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 }}" accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right"></span></a> |
||||
{% endif %} |
||||
{% if prev %} |
||||
<a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><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 build_id and build_url %} |
||||
{% trans build_url=build_url, build_id=build_id %} |
||||
<span class="build"> |
||||
Build |
||||
<a href="{{ build_url }}">{{ build_id }}</a>. |
||||
</span> |
||||
{% endtrans %} |
||||
{%- elif commit %} |
||||
{% trans commit=commit %} |
||||
<span class="commit"> |
||||
Revision <code>{{ commit }}</code>. |
||||
</span> |
||||
{% endtrans %} |
||||
{%- elif last_updated %} |
||||
<span class="lastupdated"> |
||||
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %} |
||||
</span> |
||||
{%- endif %} |
||||
|
||||
</p> |
||||
</div> |
||||
|
||||
{%- if show_sphinx %} |
||||
{% trans %}Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %}. |
||||
{%- endif %} |
||||
|
||||
{%- block extrafooter %} {% endblock %} |
||||
|
||||
</footer> |
||||
|
||||
@ -1,113 +0,0 @@ |
||||
{# 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 %} |
||||
{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %} |
||||
|
||||
<!DOCTYPE html> |
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="{{ lang_attr }}" > <![endif]--> |
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="{{ lang_attr }}" > <!--<![endif]--> |
||||
<head> |
||||
<meta charset="utf-8"> |
||||
{{ metatags }} |
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0"> |
||||
{% block htmltitle %} |
||||
<title>{{ title|striptags|e }}{{ titlesuffix }}</title> |
||||
{% endblock %} |
||||
|
||||
|
||||
{# JAVASCRIPTS #} |
||||
<script type="text/javascript" src="{{ pathto('_static/js/modernizr.min.js', 1) }}"></script> |
||||
{%- if not embedded %} |
||||
{# XXX Sphinx 1.8.0 made this an external js-file, quick fix until we refactor the template to inherert more blocks directly from sphinx #} |
||||
{% if sphinx_version >= "1.8.0" %} |
||||
<script type="text/javascript" id="documentation_options" data-url_root="{{ pathto('', 1) }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script> |
||||
{%- for scriptfile in script_files %} |
||||
{{ js_tag(scriptfile) }} |
||||
{%- endfor %} |
||||
{% else %} |
||||
<script type="text/javascript"> |
||||
var DOCUMENTATION_OPTIONS = { |
||||
URL_ROOT:'{{ url_root }}', |
||||
VERSION:'{{ release|e }}', |
||||
LANGUAGE:'{{ language }}', |
||||
COLLAPSE_INDEX:false, |
||||
FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}', |
||||
HAS_SOURCE: {{ has_source|lower }}, |
||||
SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}' |
||||
}; |
||||
</script> |
||||
{%- for scriptfile in script_files %} |
||||
<script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script> |
||||
{%- endfor %} |
||||
{% endif %} |
||||
<script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script> |
||||
{%- endif %} |
||||
|
||||
{# CSS #} |
||||
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" /> |
||||
<link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" /> |
||||
{%- for css in css_files %} |
||||
{%- if css|attr("rel") %} |
||||
<link rel="{{ css.rel }}" href="{{ pathto(css.filename, 1) }}" type="text/css"{% if css.title is not none %} title="{{ css.title }}"{% endif %} /> |
||||
{%- else %} |
||||
<link rel="stylesheet" href="{{ pathto(css, 1) }}" type="text/css" /> |
||||
{%- endif %} |
||||
{%- endfor %} |
||||
|
||||
{%- for cssfile in extra_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 %} |
||||
{%- 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> |
||||
|
||||
<body class="wy-body-for-nav"> |
||||
|
||||
<div class="wy-nav-content"> |
||||
{%- block content %} |
||||
<div class="rst-content"> |
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
||||
{%- block document %} |
||||
<div itemprop="articleBody"> |
||||
{% block body %}{% endblock %} |
||||
</div> |
||||
{% if self.comments()|trim %} |
||||
<div class="articleComments"> |
||||
{% block comments %}{% endblock %} |
||||
</div> |
||||
{% endif%} |
||||
</div> |
||||
{%- endblock %} |
||||
{% include "footer.html" %} |
||||
</div> |
||||
{%- endblock %} |
||||
</div> |
||||
|
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,50 +0,0 @@ |
||||
{# |
||||
basic/search.html |
||||
~~~~~~~~~~~~~~~~~ |
||||
|
||||
Template for the search page. |
||||
|
||||
:copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS. |
||||
:license: BSD, see LICENSE for details. |
||||
#} |
||||
{%- extends "layout.html" %} |
||||
{% set title = _('Search') %} |
||||
{% set script_files = script_files + ['_static/searchtools.js'] %} |
||||
{% block footer %} |
||||
<script type="text/javascript"> |
||||
jQuery(function() { Search.loadIndex("{{ pathto('searchindex.js', 1) }}"); }); |
||||
</script> |
||||
{# this is used when loading the search index using $.ajax fails, |
||||
such as on Chrome for documents on localhost #} |
||||
<script type="text/javascript" id="searchindexloader"></script> |
||||
{{ super() }} |
||||
{% endblock %} |
||||
{% block body %} |
||||
<noscript> |
||||
<div id="fallback" class="admonition warning"> |
||||
<p class="last"> |
||||
{% trans %}Please activate JavaScript to enable the search |
||||
functionality.{% endtrans %} |
||||
</p> |
||||
</div> |
||||
</noscript> |
||||
|
||||
{% if search_performed %} |
||||
<h2>{{ _('Search Results') }}</h2> |
||||
{% if not search_results %} |
||||
<p>{{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}</p> |
||||
{% endif %} |
||||
{% endif %} |
||||
<div id="search-results"> |
||||
{% if search_results %} |
||||
<ul> |
||||
{% for href, caption, context in search_results %} |
||||
<li> |
||||
<a href="{{ pathto(item.href) }}">{{ caption }}</a> |
||||
<p class="context">{{ context|e }}</p> |
||||
</li> |
||||
{% endfor %} |
||||
</ul> |
||||
{% endif %} |
||||
</div> |
||||
{% endblock %} |
||||
@ -1,9 +0,0 @@ |
||||
{%- if builder != 'singlehtml' %} |
||||
<div role="search"> |
||||
<form id="rtd-search-form" class="wy-form" action="{{ pathto('search') }}" method="get"> |
||||
<input type="text" name="q" placeholder="{{ _('Search docs') }}" /> |
||||
<input type="hidden" name="check_keywords" value="yes" /> |
||||
<input type="hidden" name="area" value="default" /> |
||||
</form> |
||||
</div> |
||||
{%- endif %} |
||||
@ -1,2 +0,0 @@ |
||||
[theme] |
||||
inherit = sphinx_rtd_theme |
||||
@ -1,37 +0,0 @@ |
||||
{% if READTHEDOCS %} |
||||
{# Add rst-badge after rst-versions for small badge style. #} |
||||
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> |
||||
<span class="rst-current-version" data-toggle="rst-current-version"> |
||||
<span class="fa fa-book"> Read the Docs</span> |
||||
v: {{ current_version }} |
||||
<span class="fa fa-caret-down"></span> |
||||
</span> |
||||
<div class="rst-other-versions"> |
||||
<dl> |
||||
<dt>{{ _('Versions') }}</dt> |
||||
{% for slug, url in versions %} |
||||
<dd><a href="{{ url }}">{{ slug }}</a></dd> |
||||
{% endfor %} |
||||
</dl> |
||||
<dl> |
||||
<dt>{{ _('Downloads') }}</dt> |
||||
{% for type, url in downloads %} |
||||
<dd><a href="{{ url }}">{{ type }}</a></dd> |
||||
{% endfor %} |
||||
</dl> |
||||
<dl> |
||||
<dt>{{ _('On Read the Docs') }}</dt> |
||||
<dd> |
||||
<a href="//{{ PRODUCTION_DOMAIN }}/projects/{{ slug }}/?fromdocs={{ slug }}">{{ _('Project Home') }}</a> |
||||
</dd> |
||||
<dd> |
||||
<a href="//{{ PRODUCTION_DOMAIN }}/builds/{{ slug }}/?fromdocs={{ slug }}">{{ _('Builds') }}</a> |
||||
</dd> |
||||
</dl> |
||||
<hr/> |
||||
{% trans %}Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.{% endtrans %} |
||||
|
||||
</div> |
||||
</div> |
||||
{% endif %} |
||||
|
||||
Loading…
Reference in new issue