summaryrefslogtreecommitdiffstats
path: root/doc/_themes
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 11:54:28 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 11:54:28 +0000
commite6918187568dbd01842d8d1d2c808ce16a894239 (patch)
tree64f88b554b444a49f656b6c656111a145cbbaa28 /doc/_themes
parentInitial commit. (diff)
downloadceph-e6918187568dbd01842d8d1d2c808ce16a894239.tar.xz
ceph-e6918187568dbd01842d8d1d2c808ce16a894239.zip
Adding upstream version 18.2.2.upstream/18.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/_themes')
-rw-r--r--doc/_themes/ceph/layout.html252
-rw-r--r--doc/_themes/ceph/static/ceph.css_t199
-rw-r--r--doc/_themes/ceph/theme.conf4
3 files changed, 455 insertions, 0 deletions
diff --git a/doc/_themes/ceph/layout.html b/doc/_themes/ceph/layout.html
new file mode 100644
index 000000000..f89edfe37
--- /dev/null
+++ b/doc/_themes/ceph/layout.html
@@ -0,0 +1,252 @@
+{# TEMPLATE VAR SETTINGS #}
+{%- set url_root = pathto('', 1) %}
+{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
+{%- if not embedded and docstitle %}
+ {%- set titlesuffix = " &mdash; "|safe + docstitle|e %}
+{%- else %}
+ {%- set titlesuffix = "" %}
+{%- endif %}
+{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %}
+{%- set sphinx_writer = 'writer-html5' if html5_doctype else 'writer-html4' %}
+
+<!DOCTYPE html>
+<html class="{{ sphinx_writer }}" lang="{{ lang_attr }}" >
+<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 %}
+
+ {# 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 %}
+
+ {# FAVICON #}
+ {% if favicon %}
+ <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
+ {% endif %}
+
+ {# CANONICAL URL (deprecated) #}
+ {% if theme_canonical_url and not pageurl %}
+ <link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
+ {% endif %}
+
+ {# CANONICAL URL #}
+ {%- if pageurl %}
+ <link rel="canonical" href="{{ pageurl|e }}" />
+ {%- endif %}
+
+ {# JAVASCRIPTS #}
+ {%- block scripts %}
+ <!--[if lt IE 9]>
+ <script src="{{ pathto('_static/js/html5shiv.min.js', 1) }}"></script>
+ <![endif]-->
+ {%- if not embedded %}
+ {# XXX Sphinx 1.8.0 made this an external js-file, quick fix until we refactor the template to inherit more blocks directly from sphinx #}
+ {% if sphinx_version >= "1.8.0" %}
+ <script type="text/javascript" id="documentation_options" data-url_root="{{ url_root }}" 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>
+
+ {# OPENSEARCH #}
+ {%- 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 %}
+ {%- endblock %}
+
+ {%- 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">
+
+ {% block extrabody %} {% endblock %}
+ <header class="top-bar">
+ {% include "breadcrumbs.html" %}
+ </header>
+ <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" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}>
+ {% 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>
+
+ {% block navigation %}
+ <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>
+ {% endblock %}
+ </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 %}
+ <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" %}
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.Navigation.enable({{ 'true' if theme_sticky_navigation|tobool else 'false' }});
+ });
+ </script>
+
+ {# Do not conflict with RTD insertion of analytics script #}
+ {% if not READTHEDOCS %}
+ {% if theme_analytics_id %}
+ <!-- Theme Analytics -->
+ <script>
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+ ga('create', '{{ theme_analytics_id }}', 'auto');
+ {% if theme_analytics_anonymize_ip|tobool %}
+ ga('set', 'anonymizeIp', true);
+ {% endif %}
+ ga('send', 'pageview');
+ </script>
+
+ {% endif %}
+ {% endif %}
+
+ {%- block footer %} {% endblock %}
+
+</body>
+</html>
diff --git a/doc/_themes/ceph/static/ceph.css_t b/doc/_themes/ceph/static/ceph.css_t
new file mode 100644
index 000000000..1be74fd45
--- /dev/null
+++ b/doc/_themes/ceph/static/ceph.css_t
@@ -0,0 +1,199 @@
+@import url("css/theme.css");
+@import url('https://fonts.googleapis.com/css?family=Titillium+Web:400,300,700');
+
+.top-bar {
+ position: fixed;
+ min-width: auto;
+ top: 0;
+ left: 0;
+ width: 100%;
+ z-index: 5050;
+}
+
+.top-bar > div[role=navigation] {
+ border-top: 5px solid #F05C56;
+}
+
+.top-bar > div[role=navigation] > ul {
+ border-top: 5px solid #9C4850;
+ padding: 0 1em;
+}
+
+.top-bar > div[role=navigation] > hr {
+ margin: 0 0 10px;
+}
+
+body {
+ padding-top: 40px;
+}
+
+.wy-nav-side {
+ padding-top: 33px;
+}
+
+.wy-nav-content {
+ padding-top: 0;
+ min-width: 450px;
+ max-width: 940px;
+}
+
+.wy-breadcrumbs {
+ background-color: #80D2DC;
+ font-size: 0.9em;
+}
+
+.wy-nav-content-wrap.shift {
+ top: 2em;
+}
+
+section h1,
+section h2,
+section h3,
+section h4,
+section h5,
+section h6 {
+ font-weight: normal;
+ margin: 30px 0px 10px 0px;
+ padding: 5px 0 5px 10px;
+ color: #212224;
+ text-transform: uppercase;
+}
+
+section h1 {
+ border-top: 20px solid white; margin-top: 0;
+}
+
+section h1 { font-family: Titillium Web; font-size: 200%; background-color: #99DAE3;}
+section h2 { font-family: Titillium Web; font-size: 150%; background-color: #B2E3EA; }
+section h3 { font-family: Titillium Web; font-size: 120%; background-color: #CCECF1; }
+section h4 { font-family: Helvetica, Arial, sans-serif; font-size: 110%; background-color: #CCECF1; }
+section h5 { font-family: Helvetica, Arial, sans-serif; font-size: 100%; background-color: #CCECF1; }
+section h6 { font-family: Helvetica, Arial, sans-serif; font-size: 100%; background-color: #CCECF1; }
+
+/* nature theme */
+div.highlight {
+ background-color: white;
+}
+
+/* admonition */
+.rst-content .tip .admonition-title {
+ background-color: #1abc9c;
+}
+
+.admonition.tip {
+ background-color: #B2EBD8;
+ border: 1px solid #55AEBA;
+}
+
+.admonition.note {
+ background-color: #A9D1EC;
+ border: 1px solid #6AB0DE;
+}
+
+
+.rst-content .important .admonition-title {
+ background-color: #F05C56;
+}
+
+.admonition.important {
+ background-color: #FBD9D4;
+ border: 1px solid #F6A99E;
+}
+
+.admonition.warning {
+ border: 1px solid #F5DBC6;
+}
+
+/* table */
+.rst-content table.docutils {
+ border: 0;
+ border-collapse: collapse;
+}
+
+.rst-content li dl:not(.docutils) dt {
+ display: inline-block;
+}
+
+.rst-content table.docutils tr p:last-child {
+ margin-bottom: 0;
+}
+
+html.writer-html5 .rst-content table.docutils th,
+.rst-content table.docutils th,
+.rst-content table.docutils td,
+.rst-content table.docutils tbody > tr:last-child td {
+ border-top: 0;
+ border-left: 0;
+ border-right: 0;
+ border-bottom: 1px solid #aaa;
+ white-space: normal;
+}
+
+.rst-content table.docutils ul {
+ margin-bottom: inherit;
+}
+
+/* lists */
+.rst-content .section dl:not(.docutils) dt {
+ display: inline-block;
+}
+
+.rst-content table.docutils ul + ul {
+ margin-top: 1em;
+}
+
+.rst-content section ul li {
+ list-style: disc;
+ margin-left: 24px;
+}
+
+.rst-content section ol li>p,
+.rst-content section ol li>p:last-child,
+.rst-content section ul li>p,
+.rst-content section ul li>p:last-child {
+ margin-bottom: 12px;
+}
+
+.rst-content section ol li>p:only-child,
+.rst-content section ol li>p:only-child:last-child,
+.rst-content section ul li>p:only-child,
+.rst-content section ul li>p:only-child:last-child {
+ margin-bottom: 0;
+}
+
+/* versions */
+.injected .rst-versions.rst-badge {
+ left: 0;
+ right: 0;
+ bottom: 0;
+}
+
+.injected .rst-versions.rst-badge .rst-current-version {
+ bottom: 0;
+ line-height: 1px;
+ padding: 12px;
+ height: auto;
+}
+
+.columns-2,
+.columns-3 {
+ display: flex;
+}
+
+.columns-2 > div,
+.columns-3 > div {
+ flex: 1;
+ padding: 0 10px 10px 0;
+}
+
+.columns-2 > div {
+ width: 50%;
+}
+
+.columns-3 > div {
+ width: 33.33%;
+}
+
+div[class*="highlight-"] {
+ margin-bottom: 12px;
+}
diff --git a/doc/_themes/ceph/theme.conf b/doc/_themes/ceph/theme.conf
new file mode 100644
index 000000000..48fb4140d
--- /dev/null
+++ b/doc/_themes/ceph/theme.conf
@@ -0,0 +1,4 @@
+[theme]
+inherit = sphinx_rtd_theme
+stylesheet = ceph.css
+pygments_style = tango