-
Notifications
You must be signed in to change notification settings - Fork 217
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Using Read the Docs and Sphinx to get a dynamic and clean manual
- v3.19.0.0
- v3.18.0.0
- v3.17.0.0
- v3.16.0.0
- v3.15.0.0
- v3.14.0.0
- v3.13.0.0
- v3.12.0.0
- v3.11.0.0
- v3.10.0.0
- v3.9.0.0
- v3.8.0.0
- v3.7.0.0
- v3.6.1.0
- v3.6.0.0
- v3.5.0.0
- v3.4.0.0
- v3.3.0.1
- v3.3.0.0
- v3.2.1.0
- v3.2.0.1
- v3.2.0.0
- v3.1.1.2
- v3.1.1.1
- v3.1.1.0
- v3.0.0.2
- v3.0.0.1
- v3.0.0.0
- v2.13.0.0
- v2.12.0.0
- v2.11.0.1
- v2.11.0.0
- v2.10.0.0
- v2.9.1.1
- v2.9.1.0
- v2.9.0.1
- v2.9.0.0
- v2.8.1.0
- v2.8.0.0
- v2.7.1.0
- v2.7.0.0
- v2.6.4.0
- v2.6.3.0
- v2.6.2.0
- v2.6.1.1
- v2.6.0.0
- v2.5.0.0
- v2.4.2.0
- v2.4.1.0
- v2.4.0.0
- v2.3.0.0
- v2.2.0.0
- v2.1.0.0
- v2.0.2.0
- v2.0.1.0
- v2.0.0.0
- v1.13.2.2
- v1.13.2.1
- v1.13.2.0
- v1.13.1.0
- v1.13.0.0
- v1.12.19.0
- v1.12.18.0
- v1.12.17.0
- v1.12.16.0
- v1.12.15.0
- v1.12.14.0
- v1.12.13.0
- v1.12.12.0
- v1.12.11.0
- v1.12.10.0
- v1.12.9.0
- v1.12.8.0
- v1.12.7.0
- v1.12.6.0
- v1.12.5.0
- v1.12.4.0
- v1.12.3.0
- v1.12.2.0
- v1.12.1.0
- v1.12.0.0
- v1.11.11.0
- v1.11.10.0
- v1.11.9.0
- v1.11.8.0
- v1.11.7.0
- v1.11.6.0
- v1.11.5.0
- v1.11.4.0
- v1.11.3.0
- v1.11.2.0
- v1.11.1.0
- v1.11.0.0
- v1.10.7.0
- v1.10.6.1
- v1.10.6.0
- v1.10.5.0
- v1.10.4.0
- v1.10.3.0
- v1.10.2.0
- v1.10.0.1
- v1.10.0.0
- v1.9.1
- v1.9.0
- v1.8.1
- v1.8
- v1.7
- v1.6
- v1.5
- v1.4.1
- v1.3
- v1.2.1
- v1.2
- v1.1.1
- v1.1
- v1.00
- 3.1.0.0
- 3.0.1.0
- 1.4
Showing
27 changed files
with
3,462 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
"""Sphinx ReadTheDocs theme. | ||
From https://github.com/ryan-roemer/sphinx-bootstrap-theme. | ||
""" | ||
from os import path | ||
|
||
__version__ = '0.4.2' | ||
__version_full__ = __version__ | ||
|
||
|
||
def get_html_theme_path(): | ||
"""Return list of HTML theme paths.""" | ||
cur_dir = path.abspath(path.dirname(path.dirname(__file__))) | ||
return cur_dir | ||
|
||
# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package | ||
def setup(app): | ||
app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__))) |
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,82 @@ | ||
{# 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" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> | ||
{% endif %} | ||
</div> | ||
{% endif %} | ||
<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,52 @@ | ||
<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" 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 %} | ||
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %} | ||
{%- 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> | ||
|
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,227 @@ | ||
{# 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 %} | ||
|
||
{# FAVICON #} | ||
{% if favicon %} | ||
<link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/> | ||
{% endif %} | ||
{# CANONICAL URL #} | ||
{% if theme_canonical_url %} | ||
<link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/> | ||
{% endif %} | ||
|
||
{# 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 %} | ||
|
||
<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 %} | ||
|
||
{# Keep modernizr in head - http://modernizr.com/docs/#installing #} | ||
<script src="{{ pathto('_static/js/modernizr.min.js', 1) }}"></script> | ||
|
||
</head> | ||
|
||
<body class="wy-body-for-nav"> | ||
|
||
{% block extrabody %} {% endblock %} | ||
<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-scroll"> | ||
<div class="wy-side-nav-search"> | ||
{% block sidebartitle %} | ||
|
||
{% if logo and theme_logo_only %} | ||
<a href="{{ pathto(master_doc) }}"> | ||
{% else %} | ||
<a href="{{ pathto(master_doc) }}" class="icon icon-home"> {{ project }} | ||
{% endif %} | ||
|
||
{% if logo %} | ||
{# Not strictly valid HTML, but it's the only way to display/scale | ||
it properly, without weird scripting or heaps of work | ||
#} | ||
<img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="Logo"/> | ||
{% endif %} | ||
</a> | ||
|
||
{% if theme_display_version %} | ||
{%- set nav_version = version %} | ||
{% if READTHEDOCS and current_version %} | ||
{%- set nav_version = current_version %} | ||
{% endif %} | ||
{% if nav_version %} | ||
<div class="version"> | ||
{{ nav_version }} | ||
</div> | ||
{% endif %} | ||
{% endif %} | ||
|
||
{% include "searchbox.html" %} | ||
|
||
{% endblock %} | ||
</div> | ||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> | ||
{% block menu %} | ||
{# | ||
The singlehtml builder doesn't handle this toctree call when the | ||
toctree is empty. Skip building this for now. | ||
#} | ||
{% if 'singlehtml' not in builder %} | ||
{% set global_toc = toctree(maxdepth=theme_navigation_depth|int, | ||
collapse=theme_collapse_navigation|tobool, | ||
includehidden=theme_includehidden|tobool, | ||
titles_only=theme_titles_only|tobool) %} | ||
{% endif %} | ||
{% if global_toc %} | ||
{{ global_toc }} | ||
{% else %} | ||
<!-- Local TOC --> | ||
<div class="local-toc">{{ toc }}</div> | ||
{% endif %} | ||
{% endblock %} | ||
</div> | ||
</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" aria-label="top navigation"> | ||
{% block mobile_nav %} | ||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
<a href="{{ pathto(master_doc) }}">{{ project }}</a> | ||
{% endblock %} | ||
</nav> | ||
|
||
|
||
<div class="wy-nav-content"> | ||
{%- block content %} | ||
{% if theme_style_external_links|tobool %} | ||
<div class="rst-content style-external-links"> | ||
{% else %} | ||
<div class="rst-content"> | ||
{% endif %} | ||
{% include "breadcrumbs.html" %} | ||
<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> | ||
|
||
</section> | ||
|
||
</div> | ||
{% include "versions.html" %} | ||
|
||
{% 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 %} | ||
|
||
{% endif %} | ||
|
||
<script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script> | ||
|
||
<script type="text/javascript"> | ||
jQuery(function () { | ||
SphinxRtdTheme.Navigation.enable({{ 'true' if theme_sticky_navigation|tobool else 'false' }}); | ||
}); | ||
</script> | ||
|
||
{%- block footer %} {% endblock %} | ||
|
||
</body> | ||
</html> |
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,50 @@ | ||
{# | ||
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 %} |
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,9 @@ | ||
{%- 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 %} |
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Binary file not shown.
Binary file added
BIN
+162 KB
Source/Docs/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.eot
Binary file not shown.
2,671 changes: 2,671 additions & 0 deletions
2,671
Source/Docs/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+162 KB
Source/Docs/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.ttf
Binary file not shown.
Binary file added
BIN
+95.7 KB
Source/Docs/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.woff
Binary file not shown.
Binary file added
BIN
+75.4 KB
Source/Docs/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.woff2
Binary file not shown.
4 changes: 4 additions & 0 deletions
4
Source/Docs/_themes/sphinx_rtd_theme/static/js/modernizr.min.js
Oops, something went wrong.
Oops, something went wrong.
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 @@ | ||
[theme] | ||
inherit = basic | ||
stylesheet = css/theme.css | ||
pygments_style = default | ||
|
||
[options] | ||
canonical_url = | ||
analytics_id = | ||
collapse_navigation = True | ||
sticky_navigation = True | ||
navigation_depth = 4 | ||
includehidden = True | ||
titles_only = | ||
logo_only = | ||
display_version = True | ||
prev_next_buttons_location = bottom | ||
style_external_links = False |
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,37 @@ | ||
{% 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 %} | ||
|
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,3 @@ | ||
$command = "sphinx-build -b html source build" | ||
iex $command | ||
pause |
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,191 @@ | ||
# -*- coding: utf-8 -*- | ||
# | ||
# Configuration file for the Sphinx documentation builder. | ||
# | ||
# This file does only contain a selection of the most common options. For a | ||
# full list see the documentation: | ||
# http://www.sphinx-doc.org/en/master/config | ||
|
||
# -- Path setup -------------------------------------------------------------- | ||
|
||
# If extensions (or modules to document with autodoc) are in another directory, | ||
# add these directories to sys.path here. If the directory is relative to the | ||
# documentation root, use os.path.abspath to make it absolute, like shown here. | ||
# | ||
# import os | ||
# import sys | ||
# sys.path.insert(0, os.path.abspath('.')) | ||
|
||
|
||
# -- Project information ----------------------------------------------------- | ||
|
||
project = u'Realistic Progression One (RP-1)' | ||
copyright = u'2018, KSP-RO Team' | ||
author = u'KSP-RO Team' | ||
|
||
# The short X.Y version | ||
version = u'' | ||
# The full version, including alpha/beta/rc tags | ||
release = u'v0.6' | ||
|
||
|
||
# -- General configuration --------------------------------------------------- | ||
|
||
# If your documentation needs a minimal Sphinx version, state it here. | ||
# | ||
# needs_sphinx = '1.0' | ||
|
||
# Add any Sphinx extension module names here, as strings. They can be | ||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | ||
# ones. | ||
extensions = [ | ||
'sphinx.ext.todo', | ||
'sphinx.ext.imgmath', | ||
'sphinx.ext.githubpages', | ||
] | ||
|
||
# Add any paths that contain templates here, relative to this directory. | ||
templates_path = ['_templates'] | ||
|
||
# The suffix(es) of source filenames. | ||
# You can specify multiple suffix as a list of string: | ||
# | ||
# source_suffix = ['.rst', '.md'] | ||
source_suffix = '.rst' | ||
|
||
# The master toctree document. | ||
master_doc = 'index' | ||
|
||
# The language for content autogenerated by Sphinx. Refer to documentation | ||
# for a list of supported languages. | ||
# | ||
# This is also used if you do content translation via gettext catalogs. | ||
# Usually you set "language" from the command line for these cases. | ||
language = None | ||
|
||
# List of patterns, relative to source directory, that match files and | ||
# directories to ignore when looking for source files. | ||
# This pattern also affects html_static_path and html_extra_path. | ||
exclude_patterns = [] | ||
|
||
# The name of the Pygments (syntax highlighting) style to use. | ||
pygments_style = None | ||
|
||
|
||
# -- Options for HTML output ------------------------------------------------- | ||
|
||
# The theme to use for HTML and HTML Help pages. See the documentation for | ||
# a list of builtin themes. | ||
# | ||
html_theme = 'sphinx_rtd_theme' | ||
|
||
# Theme options are theme-specific and customize the look and feel of a theme | ||
# further. For a list of options available for each theme, see the | ||
# documentation. | ||
# | ||
html_theme_options = { | ||
'display_version': True, | ||
'prev_next_buttons_location': 'bottom', | ||
'style_external_links': True, | ||
# TOC Options | ||
'collapse_navigation': False, | ||
'sticky_navigation': True | ||
} | ||
|
||
# Add any paths that contain custom static files (such as style sheets) here, | ||
# relative to this directory. They are copied after the builtin static files, | ||
# so a file named "default.css" will overwrite the builtin "default.css". | ||
html_static_path = ['_themes'] | ||
|
||
# Custom sidebar templates, must be a dictionary that maps document names | ||
# to template names. | ||
# | ||
# The default sidebars (for documents that don't match any pattern) are | ||
# defined by theme itself. Builtin themes are using these templates by | ||
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', | ||
# 'searchbox.html']``. | ||
# | ||
# html_sidebars = {} | ||
|
||
|
||
# -- Options for HTMLHelp output --------------------------------------------- | ||
|
||
# Output file base name for HTML help builder. | ||
htmlhelp_basename = 'RealisticProgressionOneRP-1doc' | ||
|
||
|
||
# -- Options for LaTeX output ------------------------------------------------ | ||
|
||
latex_elements = { | ||
# The paper size ('letterpaper' or 'a4paper'). | ||
# | ||
# 'papersize': 'letterpaper', | ||
|
||
# The font size ('10pt', '11pt' or '12pt'). | ||
# | ||
# 'pointsize': '10pt', | ||
|
||
# Additional stuff for the LaTeX preamble. | ||
# | ||
# 'preamble': '', | ||
|
||
# Latex figure (float) alignment | ||
# | ||
# 'figure_align': 'htbp', | ||
} | ||
|
||
# Grouping the document tree into LaTeX files. List of tuples | ||
# (source start file, target name, title, | ||
# author, documentclass [howto, manual, or own class]). | ||
latex_documents = [ | ||
(master_doc, 'RealisticProgressionOneRP-1.tex', u'Realistic Progression One (RP-1) Documentation', | ||
u'KSP-RO Team', 'manual'), | ||
] | ||
|
||
|
||
# -- Options for manual page output ------------------------------------------ | ||
|
||
# One entry per manual page. List of tuples | ||
# (source start file, name, description, authors, manual section). | ||
man_pages = [ | ||
(master_doc, 'realisticprogressiononerp-1', u'Realistic Progression One (RP-1) Documentation', | ||
[author], 1) | ||
] | ||
|
||
|
||
# -- Options for Texinfo output ---------------------------------------------- | ||
|
||
# Grouping the document tree into Texinfo files. List of tuples | ||
# (source start file, target name, title, author, | ||
# dir menu entry, description, category) | ||
texinfo_documents = [ | ||
(master_doc, 'RealisticProgressionOneRP-1', u'Realistic Progression One (RP-1) Documentation', | ||
author, 'RealisticProgressionOneRP-1', 'One line description of project.', | ||
'Miscellaneous'), | ||
] | ||
|
||
|
||
# -- Options for Epub output ------------------------------------------------- | ||
|
||
# Bibliographic Dublin Core info. | ||
epub_title = project | ||
|
||
# The unique identifier of the text. This can be a ISBN number | ||
# or the project homepage. | ||
# | ||
# epub_identifier = '' | ||
|
||
# A unique identification for the text. | ||
# | ||
# epub_uid = '' | ||
|
||
# A list of files that should not be packed into the epub file. | ||
epub_exclude_files = ['search.html'] | ||
|
||
|
||
# -- Extension configuration ------------------------------------------------- | ||
|
||
# -- Options for todo extension ---------------------------------------------- | ||
|
||
# If true, `todo` and `todoList` produce output, else they produce nothing. | ||
todo_include_todos = True |
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,6 @@ | ||
.. _/features/crewHandling: | ||
|
||
Crew Handling | ||
================================ | ||
|
||
It is innapropriate to handle your crew. |
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,6 @@ | ||
.. _/features/facilities: | ||
|
||
Facility Changes | ||
================================ | ||
|
||
The facilities are a changin'. |
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,6 @@ | ||
.. _/features/maintenance: | ||
|
||
Maintenance | ||
================================ | ||
|
||
You think all these fancy buildings are free? |
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,6 @@ | ||
.. _/features/science: | ||
|
||
Science Overhaul | ||
================================ | ||
|
||
Science changed. |
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,6 @@ | ||
.. _/features/techTree: | ||
|
||
Tech Tree | ||
================================ | ||
|
||
We have a tech tree. Cool. |
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,6 @@ | ||
.. _/features/tooling: | ||
|
||
Tooling | ||
================================ | ||
|
||
Tool those tanks fool. |
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,54 @@ | ||
.. _index: | ||
|
||
.. toctree:: | ||
:maxdepth: 5 | ||
:caption: Features | ||
|
||
/features/techTree | ||
/features/science | ||
/features/tooling | ||
/features/maintenance | ||
/features/crewHandling | ||
/features/facilities | ||
|
||
Realistic Progression One (RP-1) | ||
================================ | ||
|
||
Welcome! | ||
-------- | ||
|
||
Realistic Progression One (RP-1) is a career mode addon for | ||
the `Realism Overhaul`_ suite of mods for `Kerbal Space Program`_. | ||
|
||
RP-1 is the quasi-successor to RP-0. There have been many changes | ||
from RP-0 to RP-1 and the game plays much differently. It was decided | ||
that it deserved a new name, and RP-1 was born. Where RP-0 called | ||
itself the "lightweight career add-on", RP-1 is most definitely not. | ||
It offers a completely different experience from most anything | ||
else that is available for `Kerbal Space Program`_. | ||
|
||
What is New? | ||
------------ | ||
|
||
A lot has changed from RP-0 and this is a concise list of some of the | ||
biggest changes. Click on each link to go to the corresponding page | ||
that has much more detail on each feature. | ||
|
||
* :doc:`/features/techTree` — Custom tech tree specifically designed for RP-1 | ||
* :doc:`/features/science` — All new science parts that encoruage multiple missions | ||
* :doc:`/features/tooling` — Simulates the "tooling" costs associated with setting up new production lines | ||
* :doc:`/features/maintenance` — Each facility and astronaut have a recurring cost for upkeep | ||
* :doc:`/features/crewHandling` — Crew needs to train before taking on missions and will retire if not used | ||
* :doc:`/features/facilities` — Facility upgrades have been overhahuled | ||
|
||
|
||
|
||
Indices and tables | ||
================== | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` | ||
|
||
.. _Realism Overhaul: https://github.com/KSP-RO/RealismOverhaul | ||
.. _Kerbal Space Program: https://kerbalspaceprogram.com |