Skip to content

Commit

Permalink
update docs;
Browse files Browse the repository at this point in the history
  • Loading branch information
@twiddli
twiddli committed Apr 15, 2018
1 parent 8dbc8c7 commit 9360978
Show file tree
Hide file tree
Showing 47 changed files with 380 additions and 172 deletions.
2 changes: 1 addition & 1 deletion docs/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 6c2f459488664ba340ad8ca43dbdc5b0
config: 59bbc1508277bf52f76fc7232995f06f
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/.doctrees/api.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/api_general.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/api_plugin.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/client.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/env.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/.doctrees/index.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/install.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/plugin.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/settings.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/switches.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/todo.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/translation.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/usage.doctree
View file
Binary file not shown.
7 changes: 4 additions & 3 deletions docs/_modules/happypanda/core/command.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>happypanda.core.command &#8212; HappyPanda X 0.0.12#124 documentation</title>
<title>happypanda.core.command &#8212; HappyPanda X 0.0.13#124 documentation</title>
<link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/style.css" type="text/css" />
Expand Down Expand Up @@ -39,7 +39,7 @@
</button>
<a class="navbar-brand" href="../../../index.html">
HappyPanda X</a>
<span class="navbar-text navbar-version pull-left"><b>0.0.12#124</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.0.13#124</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand All @@ -58,7 +58,8 @@
<li class="toctree-l1"><a class="reference internal" href="../../../install.html">Installing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../install.html#building">Building</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html">Using HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#exposing-happypanda-x">Exposing Happypanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#securing-happypanda-x">Securing Happypanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#exposing-happypanda-x">Exposing HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../translation.html">Translations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../switches.html">Command-Line Arguments</a></li>
Expand Down
7 changes: 4 additions & 3 deletions docs/_modules/happypanda/interface/database.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>happypanda.interface.database &#8212; HappyPanda X 0.0.12#124 documentation</title>
<title>happypanda.interface.database &#8212; HappyPanda X 0.0.13#124 documentation</title>
<link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/style.css" type="text/css" />
Expand Down Expand Up @@ -39,7 +39,7 @@
</button>
<a class="navbar-brand" href="../../../index.html">
HappyPanda X</a>
<span class="navbar-text navbar-version pull-left"><b>0.0.12#124</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.0.13#124</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand All @@ -58,7 +58,8 @@
<li class="toctree-l1"><a class="reference internal" href="../../../install.html">Installing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../install.html#building">Building</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html">Using HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#exposing-happypanda-x">Exposing Happypanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#securing-happypanda-x">Securing Happypanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#exposing-happypanda-x">Exposing HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../translation.html">Translations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../switches.html">Command-Line Arguments</a></li>
Expand Down
20 changes: 16 additions & 4 deletions docs/_modules/happypanda/interface/enums.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>happypanda.interface.enums &#8212; HappyPanda X 0.0.12#124 documentation</title>
<title>happypanda.interface.enums &#8212; HappyPanda X 0.0.13#124 documentation</title>
<link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/style.css" type="text/css" />
Expand Down Expand Up @@ -39,7 +39,7 @@
</button>
<a class="navbar-brand" href="../../../index.html">
HappyPanda X</a>
<span class="navbar-text navbar-version pull-left"><b>0.0.12#124</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.0.13#124</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand All @@ -58,7 +58,8 @@
<li class="toctree-l1"><a class="reference internal" href="../../../install.html">Installing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../install.html#building">Building</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html">Using HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#exposing-happypanda-x">Exposing Happypanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#securing-happypanda-x">Securing Happypanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#exposing-happypanda-x">Exposing HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../translation.html">Translations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../switches.html">Command-Line Arguments</a></li>
Expand Down Expand Up @@ -339,7 +340,18 @@ <h1>Source code for happypanda.interface.enums</h1><div class="highlight"><pre>
<span class="n">CircleName</span> <span class="o">=</span> <span class="mi">40</span>

<span class="c1">#: Parody Name</span>
<span class="n">ParodyName</span> <span class="o">=</span> <span class="mi">45</span></div>
<span class="n">ParodyName</span> <span class="o">=</span> <span class="mi">45</span>

<span class="c1">#: Collection Random</span>
<span class="n">CollectionRandom</span> <span class="o">=</span> <span class="mi">50</span>
<span class="c1">#: Collection Name</span>
<span class="n">CollectionName</span> <span class="o">=</span> <span class="mi">51</span>
<span class="c1">#: Collection Date Added</span>
<span class="n">CollectionDate</span> <span class="o">=</span> <span class="mi">52</span>
<span class="c1">#: Collection Date Published</span>
<span class="n">CollectionPublished</span> <span class="o">=</span> <span class="mi">53</span>
<span class="c1">#: Collection Gallery Count</span>
<span class="n">CollectionGalleryCount</span> <span class="o">=</span> <span class="mi">54</span></div>


<div class="viewcode-block" id="ProgressType"><a class="viewcode-back" href="../../../api.html#happypanda.interface.enums.ProgressType">[docs]</a><span class="k">class</span> <span class="nc">ProgressType</span><span class="p">(</span><span class="n">_APIEnum</span><span class="p">):</span>
Expand Down
14 changes: 10 additions & 4 deletions docs/_modules/happypanda/interface/gallery.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>happypanda.interface.gallery &#8212; HappyPanda X 0.0.12#124 documentation</title>
<title>happypanda.interface.gallery &#8212; HappyPanda X 0.0.13#124 documentation</title>
<link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/style.css" type="text/css" />
Expand Down Expand Up @@ -39,7 +39,7 @@
</button>
<a class="navbar-brand" href="../../../index.html">
HappyPanda X</a>
<span class="navbar-text navbar-version pull-left"><b>0.0.12#124</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.0.13#124</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand All @@ -58,7 +58,8 @@
<li class="toctree-l1"><a class="reference internal" href="../../../install.html">Installing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../install.html#building">Building</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html">Using HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#exposing-happypanda-x">Exposing Happypanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#securing-happypanda-x">Securing Happypanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#exposing-happypanda-x">Exposing HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../translation.html">Translations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../switches.html">Command-Line Arguments</a></li>
Expand Down Expand Up @@ -192,9 +193,14 @@ <h1>Source code for happypanda.interface.gallery</h1><div class="highlight"><pre

<span class="k">def</span> <span class="nf">_get_similar</span><span class="p">(</span><span class="n">kwargs</span><span class="p">,</span> <span class="n">similar_items</span><span class="p">):</span>
<span class="n">item_list</span> <span class="o">=</span> <span class="n">message</span><span class="o">.</span><span class="n">List</span><span class="p">(</span><span class="n">db</span><span class="o">.</span><span class="n">model_name</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;db_model&#39;</span><span class="p">]),</span> <span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;db_msg&#39;</span><span class="p">])</span>
<span class="n">similar_items</span> <span class="o">=</span> <span class="n">similar_items</span><span class="p">[:</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;limit&#39;</span><span class="p">]]</span>
<span class="n">items</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="n">similar_items</span><span class="p">:</span>
<span class="n">items</span> <span class="o">=</span> <span class="n">database_cmd</span><span class="o">.</span><span class="n">GetModelItems</span><span class="p">()</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;db_model&#39;</span><span class="p">],</span> <span class="nb">set</span><span class="p">(</span><span class="n">similar_items</span><span class="p">[:</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;limit&#39;</span><span class="p">]]))</span>
<span class="n">db_items</span> <span class="o">=</span> <span class="p">{}</span> <span class="c1"># needed to sort them the way they came in</span>
<span class="k">for</span> <span class="n">g</span> <span class="ow">in</span> <span class="n">database_cmd</span><span class="o">.</span><span class="n">GetModelItems</span><span class="p">()</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;db_model&#39;</span><span class="p">],</span> <span class="nb">set</span><span class="p">(</span><span class="n">similar_items</span><span class="p">)):</span>
<span class="n">db_items</span><span class="p">[</span><span class="n">g</span><span class="o">.</span><span class="n">id</span><span class="p">]</span> <span class="o">=</span> <span class="n">g</span>
<span class="p">[</span><span class="n">items</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">db_items</span><span class="p">[</span><span class="n">x</span><span class="p">])</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">similar_items</span><span class="p">]</span>

<span class="p">[</span><span class="n">item_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">kwargs</span><span class="p">[</span><span class="s1">&#39;db_msg&#39;</span><span class="p">](</span><span class="n">x</span><span class="p">))</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">items</span><span class="p">]</span>
<span class="k">return</span> <span class="n">item_list</span>

Expand Down
7 changes: 4 additions & 3 deletions docs/_modules/happypanda/interface/meta.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>happypanda.interface.meta &#8212; HappyPanda X 0.0.12#124 documentation</title>
<title>happypanda.interface.meta &#8212; HappyPanda X 0.0.13#124 documentation</title>
<link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/style.css" type="text/css" />
Expand Down Expand Up @@ -39,7 +39,7 @@
</button>
<a class="navbar-brand" href="../../../index.html">
HappyPanda X</a>
<span class="navbar-text navbar-version pull-left"><b>0.0.12#124</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.0.13#124</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand All @@ -58,7 +58,8 @@
<li class="toctree-l1"><a class="reference internal" href="../../../install.html">Installing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../install.html#building">Building</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html">Using HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#exposing-happypanda-x">Exposing Happypanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#securing-happypanda-x">Securing Happypanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#exposing-happypanda-x">Exposing HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../translation.html">Translations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../switches.html">Command-Line Arguments</a></li>
Expand Down
7 changes: 4 additions & 3 deletions docs/_modules/happypanda/interface/settings.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>happypanda.interface.settings &#8212; HappyPanda X 0.0.12#124 documentation</title>
<title>happypanda.interface.settings &#8212; HappyPanda X 0.0.13#124 documentation</title>
<link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/style.css" type="text/css" />
Expand Down Expand Up @@ -39,7 +39,7 @@
</button>
<a class="navbar-brand" href="../../../index.html">
HappyPanda X</a>
<span class="navbar-text navbar-version pull-left"><b>0.0.12#124</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.0.13#124</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand All @@ -58,7 +58,8 @@
<li class="toctree-l1"><a class="reference internal" href="../../../install.html">Installing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../install.html#building">Building</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html">Using HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#exposing-happypanda-x">Exposing Happypanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#securing-happypanda-x">Securing Happypanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#exposing-happypanda-x">Exposing HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../translation.html">Translations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../switches.html">Command-Line Arguments</a></li>
Expand Down
7 changes: 4 additions & 3 deletions docs/_modules/happypanda/interface/tag.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>happypanda.interface.tag &#8212; HappyPanda X 0.0.12#124 documentation</title>
<title>happypanda.interface.tag &#8212; HappyPanda X 0.0.13#124 documentation</title>
<link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/style.css" type="text/css" />
Expand Down Expand Up @@ -39,7 +39,7 @@
</button>
<a class="navbar-brand" href="../../../index.html">
HappyPanda X</a>
<span class="navbar-text navbar-version pull-left"><b>0.0.12#124</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.0.13#124</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand All @@ -58,7 +58,8 @@
<li class="toctree-l1"><a class="reference internal" href="../../../install.html">Installing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../install.html#building">Building</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html">Using HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#exposing-happypanda-x">Exposing Happypanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#securing-happypanda-x">Securing Happypanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../usage.html#exposing-happypanda-x">Exposing HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../translation.html">Translations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../switches.html">Command-Line Arguments</a></li>
Expand Down

0 comments on commit 9360978

Please sign in to comment.