klink 0.1.12__py3-none-any.whl

klink/__init__.py

@@ -0,0 +1,99 @@
+import os
+import re
+import shutil
+from pathlib import Path
+from subprocess import call
+
+
+def convert_notebooks():
+    """
+    Converts IPython Notebooks to proper .rst files and moves static
+    content to the _static directory.
+    """
+    convert_status = call(["jupyter", "nbconvert", "--to", "rst", "*.ipynb"])
+    if convert_status != 0:
+        raise SystemError("Conversion failed! Status was %s" % convert_status)
+
+    notebooks = [x for x in os.listdir(".") if ".ipynb" in x and os.path.isfile(x)]
+    names = [os.path.splitext(x)[0] for x in notebooks]
+
+    for i in range(len(notebooks)):
+        name = names[i]
+        notebook = notebooks[i]
+
+        print("processing %s (%s)" % (name, notebook))
+
+        # move static files
+        sdir = "%s_files" % name
+        statics = os.listdir(sdir)
+        statics = [os.path.join(sdir, x) for x in statics]
+        [shutil.copy(x, "_static/") for x in statics]
+        shutil.rmtree(sdir)
+
+        # rename static dir in rst file
+        rst_file = "%s.rst" % name
+        print("RST file is %s" % rst_file)
+        data = None
+        with open(rst_file, "r") as f:
+            data = f.read()
+
+        if data is not None:
+            with open(rst_file, "w") as f:
+                # On Windows, bad escape character sequences are included (%5C) in static references
+                # We remove these here and replace with forward slashes as appropriate
+                # While converting the static directory name.
+                data = re.sub("%s(%%5C|/)" % sdir, "_static/", data)
+                f.write(data)
+
+        # add special tags
+        lines = None
+        with open(rst_file, "r") as f:
+            lines = f.readlines()
+
+        if lines is not None:
+            n = len(lines)
+            i = 0
+            rawWatch = False
+
+            while i < n:
+                line = lines[i]
+                # add class tags to images for css formatting
+                if "image::" in line:
+                    lines.insert(i + 1, "   :class: pynb\n")
+                    n += 1
+                elif "parsed-literal::" in line:
+                    lines.insert(i + 1, "   :class: pynb-result\n")
+                    n += 1
+                elif "raw:: html" in line:
+                    rawWatch = True
+
+                if rawWatch:
+                    if "<div" in line:
+                        line = line.replace("<div", '<div class="pynb-result"')
+                        lines[i] = line
+                        rawWatch = False
+
+                i += 1
+
+            with open(rst_file, "w") as f:
+                f.writelines(lines)
+
+
+def get_html_theme_path():
+    """Returns list of HTML theme paths."""
+    cur_dir = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
+    return cur_dir
+
+
+def setup(app):
+    app.add_html_theme("klink", Path(__file__).parent)
+
+    return {
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+    }
+
+
+__version__ = "0.1.12"
+VERSION = tuple(int(v) for v in __version__.split("."))
+__version_full__ = __version__

klink/demo.py

@@ -0,0 +1,39 @@
+class TestClass(object):
+    """
+    This is a test class. Used for demo purposes.
+
+    Lorem ipsum dolor sit amet, cu vero viris mollis his. Ex est
+    iusto constituam. Id eam graeci iuvaret facilis, erant dicunt in
+    quo, te iudico periculis interpretaris sed. Audire tibique te pro,
+    equidem repudiare an vim. Nostrum placerat liberavisse ne eam.
+    Zril corpora expetenda ex mea, at wisi vitae vocibus vix.
+
+    .. note::
+
+        Does not actually do anything. Just for demo.
+
+    Args:
+        name (str): Name arg
+        age (int): Age arg
+
+    """
+
+    def __init__(self, name, age):
+        self.name = name
+        self.age = age
+
+    def method1(self, arg1, arg2):
+        """
+        Does stuff with args.
+
+        Demo method1 - this method does stuff. Interesting right?
+
+        Args:
+            arg1 (type): The first arg needed to do stuff.
+            arg2 (type): The second arg needed to do stuff.
+
+        Returns:
+            str - stuff string
+
+        """
+        pass

klink/layout.html

@@ -0,0 +1,51 @@
+{%- extends "basic/layout.html" %}
+    {%- block extrahead %}
+        {{ super() }}
+        <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
+        {% if favicon %}
+            <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}">
+        {% endif %}
+        <link href='http://fonts.googleapis.com/css?family=Open+Sans:300,400,700' rel='stylesheet' type='text/css'>
+        <link href='http://fonts.googleapis.com/css?family=Droid+Sans+Mono:400,500,700' rel='stylesheet' type='text/css'>
+    {% endblock %}
+
+    {%- block relbar1 %}{% endblock %}
+    {%- block relbar2 %}{% endblock %}
+
+    {%- block sidebar2 %}
+        <aside>
+
+            {% if theme_logo %}
+            <a href="{{ pathto('index') }}" id="logo" title={{project}}><img class="logo" src="{{ pathto('_static/' + theme_logo, 1) }}" width="150px" height="150px" title={{project}} /></a>
+            {% endif %}
+            
+            {{ toctree(includehidden=True) }}
+
+            {% if theme_github %}
+            <ul>
+                <li><a href="https://github.com/{{theme_github}}">Github</a></li>
+            </ul>
+            {% endif %}
+
+            {%- include "searchbox.html" %}
+        </aside>
+    {% endblock %}
+
+    {%- block footer %}
+        <div class="footer">
+            {{ copyright }}
+        </div>
+
+        {% if theme_analytics_id %}
+        <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', '{{theme_analytics_id}}', 'auto');
+            ga('require', 'displayfeatures');
+            ga('send', 'pageview');
+        </script>
+        {% endif %}
+    {%- endblock %}

klink/less/klink.less

@@ -0,0 +1,399 @@
+@import "vendor/3L.less";
+@import "vendor/font-awesome/less/font-awesome.less";
+
+@white: #f7f8f9;
+@green: #29b96e;
+@green2: #39ff98;
+@green3: #0e4026;
+@green4: #1c7f4c;
+@gray: #333;
+@gray2: #777;
+@gray3: #999;
+@border: #e3e3e3;
+@weight1: 400;
+@orange: #ff9f80;
+@purple: #ad19ff;
+@gold: #cc8c14;
+@pink: #ef40ff;
+@font1: "Open Sans", "Helvetica Neue", sans-serif;
+@font2: "Droid Sans Mono", monospace, serif;
+
+.normalize();
+
+body {
+    font-family: @font1;
+    font-weight: @weight1;
+    color: @gray;
+    background: @white;
+}
+
+h1 {
+    padding-bottom: 40px;
+}
+
+a:link, a:visited {
+    color: @green;
+    text-decoration: none;
+}
+
+a:hover, a:active {
+    text-decoration: underline;
+}
+
+.border-round {
+    border: 1px solid @border;
+    .border-radius(6px);
+}
+
+* > a.headerlink {
+    display: none;
+}
+
+dd {
+    color: @gray3;
+    font-weight: @weight1;
+    max-width: 85%;
+}
+
+dl.function > dt, dl.class > dt, dl.method > dt {
+    color: @gray;
+    font-weight: bold;
+}
+
+dl tt {
+    font-family: @font1;
+}
+
+dl.function, dl.class {
+    background: #f3f4f5;
+    padding: 10px;
+    .border-round;
+}
+
+em.property {
+    font-style: normal;
+    color: @gray3;
+}
+
+dt > em {
+    font-style: normal;
+    font-weight: 400;
+}
+
+input {
+    background: transparent;
+    border: 1px solid @gray3;
+    .border-radius(3px);
+    padding: 2px 5px;
+    color: @gray2;
+    outline: none;
+    &:focus {
+        background: white;
+    }
+}
+
+aside {
+    position: fixed;
+    top: 25px;
+    width: 240px;
+    color: @gray3;
+    padding-left: 20px;
+
+    &>ul {
+        list-style: none;
+        margin: 0 4px;
+        padding: 0;
+        &>li {
+            margin-bottom: 10px;
+            font-size: 18px;
+            color: @gray2;
+            a:link, a:visited {
+                color: @gray2;
+            }
+            ul {
+                margin: 10px 0 0 0;
+                padding-left: 30px;
+                font-size: 16px;
+            }
+        }
+    }
+
+    input[type=submit] {
+        display: none;
+    }
+
+    input[type=text] {
+        width: 85%;
+    }
+}
+
+.literal {
+    color: @green;
+    font-size: 1em;
+    padding: 1px 2px;
+}
+
+.admonition {
+    padding: 10px 20px;
+    border: 1px solid @border;
+    .border-radius(6px);
+}
+
+.admonition-title {
+    font-weight: 600;
+}
+
+.ad-core {
+    border: 1px solid @border;
+    .border-radius(6px);
+    padding: 10px 20px 10px 70px;
+    position: relative;
+    color: white;
+    margin: 10px 0px;
+}
+
+.ad-core-before {
+    font-size: 2em;
+    display: block;
+    position: absolute;
+    margin: auto;
+    top: 0;
+    bottom: 0;
+    left: 20px;
+    width: 32px;
+    height: 32px;
+}
+
+.seealso
+    {
+    .ad-core;
+    background: #e3e3e3;
+    color: @gray;
+    .admonition-title {display: none;}
+    a { color: @green; }
+    &:before
+        {
+        content: @fa-var-external-link;
+        .fa;
+        .ad-core-before;
+        }
+    .literal, .highlight-note
+        {
+        color: white;
+        background: @green;
+        padding: 1px 3px;
+        .border-radius(2px);
+        }
+    }
+
+.note
+    {
+    .ad-core;
+    background: @green;
+    .admonition-title {display: none;}
+    a { color: #40ff85; }
+    &:before
+        {
+        content: @fa-var-info-circle;
+        .fa;
+        .ad-core-before;
+        }
+    .literal, .highlight-note
+        {
+        color: white;
+        background: #298354;
+        padding: 1px 3px;
+        .border-radius(2px);
+        }
+    }
+
+.warning
+    {
+    .ad-core;
+    background: #e0ab66;
+    .admonition-title {display: none;}
+    a { color: #633030; }
+    &:before
+        {
+        content: @fa-var-warning;
+        .fa;
+        .ad-core-before;
+        }
+    .literal, .highlight-note
+        {
+        color: white;
+        background: #9b6515;
+        padding: 1px 3px;
+        .border-radius(2px);
+        }
+    }
+
+.danger
+    {
+    .ad-core;
+    background: #d36871;
+    .admonition-title {display: none;}
+    a { color: #832929; }
+    &:before
+        {
+        content: @fa-var-times-circle;
+        .fa;
+        .ad-core-before;
+        }
+    .literal, .highlight-note
+        {
+        color: white;
+        background: #832929;
+        padding: 1px 3px;
+        .border-radius(2px);
+        }
+    }
+
+.footnote {
+    font-size: 0.9em;
+    border: none;
+}
+
+table {
+    border: 1px solid @border;
+    border-color: @border;
+}
+
+table td, table th {
+    padding: 5px;
+}
+
+table.field-list {
+    border: none;
+}
+
+li.toctree-l1.current {
+    font-weight: 700;
+}
+
+li.toctree-l2 {
+    font-weight: @weight1;
+}
+
+span.viewcode-link {
+    display: block;
+    position: absolute;
+    right: 0px;
+    font-size: .8em;
+    color: @green;
+    padding-right: 10px;
+}
+
+div.document {
+    max-width: 1000px;
+    margin: 20px auto;
+    position: relative;
+    min-height: 550px;
+}
+
+div.documentwrapper {
+    margin-left: 280px;
+    padding: 0 0 0 20px;
+}
+
+div.body {
+    padding-top: 10px;
+}
+
+div.footer {
+    font-size: .8em;
+    text-align: center;
+    margin: 40px 0;
+    color: @gray3;
+}
+
+.code-view {
+    background: white;
+    padding: 10px 20px;
+    border: 1px solid @border;
+    .border-radius(6px);
+    font-family: @font2;
+    font-size: 0.9em;
+}
+
+.highlight {
+    background: transparent !important;
+
+    pre {
+        .code-view;
+    }
+}
+
+.code {
+    background: transparent !important;
+
+    pre {
+        .code-view;
+    }
+}
+
+.highlight-python > pre {
+    .code-view;
+}
+
+.pynb-result > pre {
+    background: inherit;
+    border: none;
+}
+
+img.align-center {
+    display: block;
+    margin: 0 auto;
+    padding: 15px 0px;
+}
+
+img.pynb {
+    background: #fff;
+    padding: 20px;
+    display: block;
+    margin: 20px auto;
+    max-width: 95%;
+}
+
+img.logo {
+    display: block;
+    margin: 0 auto;
+    padding-bottom: 30px;
+}
+
+div.pynb-result {
+    font-family: @font2;
+    font-size: 0.9em;
+    max-width: 98%;
+    margin: 0 auto;
+    
+    table, p {
+        margin-left: 20px;
+    }
+}
+
+div#searchbox {
+    padding-top: 10px;
+}
+
+@media (max-width: 800px) {
+    div.documentwrapper {
+        padding-top: 200px;
+        margin: 0px 10px;
+    }
+    h1, .section {
+        margin: 0px !important;
+    }
+    aside {
+        position: static;
+        width: 100%;
+        margin: 5px 20px;
+        padding: 5px;
+    }
+    #logo {
+        position: absolute;
+        top: 0px;
+        left: 50%;
+        margin-left: -75px;
+    }
+}