Merge branch 'hotfix/mkdocs-cinder'

wireshell · Feb 14, 2019 · df486dc · df486dc
2 parents af33b74 + 2971acd
commit df486dc
Show file tree

Hide file tree

Showing 46 changed files with 6,571 additions and 15 deletions.
diff --git a/cinder/404.html b/cinder/404.html
@@ -0,0 +1,13 @@
+{% extends "base.html" %}
+
+{% block content %}
+
+    <div class="row-fluid">
+      <div id="main-content" class="span12">
+        <h1 id="404-page-not-found" style="text-align: center">404</h1>
+        <p style="text-align: center"><strong>Page not found</strong></p>
+        <p style="text-align: center"><a href="{{ base_url }}">Home</a></p>
+      </div>
+    </div>
+
+{% endblock %}
diff --git a/cinder/__init__.py b/cinder/__init__.py
diff --git a/cinder/base.html b/cinder/base.html
@@ -0,0 +1,143 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    {% if config.site_description %}<meta name="description" content="{{ config.site_description }}">{% endif %}
+    {% if config.site_author %}<meta name="author" content="{{ config.site_author }}">{% endif %}
+    {% if page.canonical_url %}<link rel="canonical" href="{{ page.canonical_url }}">{% endif %}
+    <link rel="{{ 'img/favicon.ico'|url }}">
+
+    {% block htmltitle %}
+    <title>{% if page.title %}{{ page.title }} - {% endif %}{{ config.site_name }}</title>
+    {% endblock %}
+
+    <link rel="stylesheet" href="//use.fontawesome.com/releases/v5.5.0/css/all.css" integrity="sha384-B4dIYHKNBt8Bc12p+WXckhzcICo0wtJAoU8YZTY5qE0Id1GSseTk6S+L3BlXeVIU" crossorigin="anonymous">
+    <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/hack-font@3.3.0/build/web/hack.min.css">
+    <link href='//fonts.googleapis.com/css?family=PT+Sans:400,400italic,700,700italic&subset=latin-ext,latin' rel='stylesheet' type='text/css'>
+    <link href='//fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,700italic,400,300,600,700&subset=latin-ext,latin' rel='stylesheet' type='text/css'>
+    <link href="{{ 'css/bootstrap-custom.min.css'|url }}" rel="stylesheet">
+    <link href="{{ 'css/base.min.css'|url }}" rel="stylesheet">
+    <link href="{{ 'css/cinder.min.css'|url }}" rel="stylesheet">
+    <link href="{{ 'css/highlight.min.css'|url }}" rel="stylesheet">
+
+    {%- for path in config['extra_css'] %}
+    <link href="{{ path|url }}" rel="stylesheet">
+    {%- endfor %}
+
+    <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+    <!--[if lt IE 9]>
+            <script src="https://cdn.jsdelivr.net/npm/html5shiv@3.7.3/dist/html5shiv.min.js"></script>
+            <script src="https://cdn.jsdelivr.net/npm/respond.js@1.4.2/dest/respond.min.js"></script>
+        <![endif]-->
+
+    <script src="//ajax.googleapis.com/ajax/libs/webfont/1.6.28/webfont.js"></script>
+    <script>
+    WebFont.load({
+        google: {
+            families: ['Open Sans', 'PT Sans']
+        }
+    });
+    </script>
+
+    {% if config.google_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', '//www.google-analytics.com/analytics.js', 'ga');
+
+    ga('create', '{{ config.google_analytics[0] }}', '{{ config.google_analytics[1] }}');
+    ga('send', 'pageview');
+    </script>
+    {% endif %}
+
+    {% block extrahead %} {% endblock %}
+</head>
+
+<body{% if page and page.is_homepage %} class="homepage" {% endif %}>
+
+    {% include "nav.html" %}
+
+    <div class="container">
+        {% block content %}
+        {% if page.meta.disable_toc %}
+        <div class="col-md-12" role="main">{% include "content.html" %}</div>
+        {% else %}
+        <div class="col-md-3">{% include "toc.html" %}</div>
+        <div class="col-md-9" role="main">{% include "content.html" %}</div>
+        {% endif %}
+        {% endblock %}
+    </div>
+
+    <footer class="col-md-12 text-center">
+        {% block footer %}
+        <hr>
+        <p>{% if config.copyright %}
+        <small>{{ config.copyright }}<br></small>
+        {% endif %}
+        <small>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</p></small>
+
+        {% if page and page.meta.revision_date %}<br>
+        <small>Revised on: {{ page.meta.revision_date }}</small>
+        {% endif %}
+        {% endblock %}
+    </footer>
+
+    <script src="//ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
+    <script src="{{ 'js/bootstrap-3.0.3.min.js'|url }}"></script>
+    <script src="{{ 'js/highlight.pack.js'|url }}"></script>
+    <script>hljs.initHighlightingOnLoad();</script>
+    <script>
+    var base_url = '{{ base_url }}';
+    </script>
+    <script src="{{ 'js/base.js'|url }}"></script>
+    {%- for path in config['extra_javascript'] %}
+    <script src="{{ path|url }}"></script>
+    {%- endfor %}
+
+    <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
+        <div class="modal-dialog">
+            <div class="modal-content">
+                <div class="modal-header">
+                    <button type="button" class="close" data-dismiss="modal">
+                        <span aria-hidden="true">&times;</span>
+                        <span class="sr-only">Close</span>
+                    </button>
+                    <h4 class="modal-title" id="exampleModalLabel">Search</h4>
+                </div>
+                <div class="modal-body">
+                    <p>
+                        From here you can search these documents. Enter your search terms below.
+                    </p>
+                    <form role="form">
+                        <div class="form-group">
+                            <input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
+                        </div>
+                    </form>
+                    <div id="mkdocs-search-results"></div>
+                </div>
+                <div class="modal-footer">
+                </div>
+            </div>
+        </div>
+    </div>
+
+    </body>
+
+</html>
+{% if page and page.is_homepage %}
+<!--
+MkDocs version : {{ mkdocs_version }}
+Build Date UTC : {{ build_date_utc }}
+-->
+{% endif %}
diff --git a/cinder/content.html b/cinder/content.html
@@ -0,0 +1,9 @@
+{% if page.meta.source %}
+<div class="source-links">
+    {% for filename in page.meta.source %}
+    <span class="label label-primary">{{ filename }}</span>
+    {% endfor %}
+</div>
+{% endif %}
+
+{{ page.content }}