Skip to content

Commit

Permalink
update docs;
Browse files Browse the repository at this point in the history
  • Loading branch information
@twiddli
twiddli committed Dec 30, 2017
1 parent 69b5c1d commit ec541c6
Show file tree
Hide file tree
Showing 40 changed files with 188 additions and 126 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: a62e92a4a7e17a5ca6b659b7759cb711
config: 7c5d9332ffc51902cd6131759b2cd183
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/usage.doctree
View file
Binary file not shown.
6 changes: 3 additions & 3 deletions docs/_modules/happypanda/core/command.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>happypanda.core.command &#8212; Happypanda X 0.0.1#110 documentation</title>
<title>happypanda.core.command &#8212; Happypanda X 0.0.2#111 documentation</title>

<link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '0.0.1#110',
VERSION: '0.0.2#111',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
Expand Down Expand Up @@ -52,7 +52,7 @@
</button>
<a class="navbar-brand" href="../../../index.html">
Happypanda X</a>
<span class="navbar-text navbar-version pull-left"><b>0.0.1#110</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.0.2#111</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
6 changes: 3 additions & 3 deletions docs/_modules/happypanda/interface/database.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>happypanda.interface.database &#8212; Happypanda X 0.0.1#110 documentation</title>
<title>happypanda.interface.database &#8212; Happypanda X 0.0.2#111 documentation</title>

<link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '0.0.1#110',
VERSION: '0.0.2#111',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
Expand Down Expand Up @@ -52,7 +52,7 @@
</button>
<a class="navbar-brand" href="../../../index.html">
Happypanda X</a>
<span class="navbar-text navbar-version pull-left"><b>0.0.1#110</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.0.2#111</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
6 changes: 3 additions & 3 deletions docs/_modules/happypanda/interface/enums.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>happypanda.interface.enums &#8212; Happypanda X 0.0.1#110 documentation</title>
<title>happypanda.interface.enums &#8212; Happypanda X 0.0.2#111 documentation</title>

<link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '0.0.1#110',
VERSION: '0.0.2#111',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
Expand Down Expand Up @@ -52,7 +52,7 @@
</button>
<a class="navbar-brand" href="../../../index.html">
Happypanda X</a>
<span class="navbar-text navbar-version pull-left"><b>0.0.1#110</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.0.2#111</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
6 changes: 3 additions & 3 deletions docs/_modules/happypanda/interface/gallery.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>happypanda.interface.gallery &#8212; Happypanda X 0.0.1#110 documentation</title>
<title>happypanda.interface.gallery &#8212; Happypanda X 0.0.2#111 documentation</title>

<link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '0.0.1#110',
VERSION: '0.0.2#111',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
Expand Down Expand Up @@ -52,7 +52,7 @@
</button>
<a class="navbar-brand" href="../../../index.html">
Happypanda X</a>
<span class="navbar-text navbar-version pull-left"><b>0.0.1#110</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.0.2#111</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
40 changes: 33 additions & 7 deletions docs/_modules/happypanda/interface/meta.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>happypanda.interface.meta &#8212; Happypanda X 0.0.1#110 documentation</title>
<title>happypanda.interface.meta &#8212; Happypanda X 0.0.2#111 documentation</title>

<link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '0.0.1#110',
VERSION: '0.0.2#111',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
Expand Down Expand Up @@ -52,7 +52,7 @@
</button>
<a class="navbar-brand" href="../../../index.html">
Happypanda X</a>
<span class="navbar-text navbar-version pull-left"><b>0.0.1#110</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.0.2#111</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down Expand Up @@ -185,26 +185,28 @@ <h1>Source code for happypanda.interface.meta</h1><div class="highlight"><pre>
<span class="c1"># &quot;&quot;&quot;</span>
<span class="c1"># return message.Message(&quot;works&quot;)</span>

<div class="viewcode-block" id="get_notification"><a class="viewcode-back" href="../../../api.html#happypanda.interface.meta.get_notification">[docs]</a><span class="k">def</span> <span class="nf">get_notification</span><span class="p">(</span><span class="n">scope</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">msg_id</span><span class="p">:</span> <span class="nb">int</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<div class="viewcode-block" id="get_notification"><a class="viewcode-back" href="../../../api.html#happypanda.interface.meta.get_notification">[docs]</a><span class="k">def</span> <span class="nf">get_notification</span><span class="p">(</span><span class="n">scope</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">msg_id</span><span class="p">:</span> <span class="nb">int</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">expired</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Not ready yet...</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">msg</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="n">constants</span><span class="o">.</span><span class="n">notification</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">constants</span><span class="o">.</span><span class="n">notification</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span><span class="n">scope</span><span class="o">=</span><span class="n">scope</span><span class="p">)</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">constants</span><span class="o">.</span><span class="n">notification</span><span class="o">.</span><span class="n">_fetch</span><span class="p">(</span><span class="n">scope</span><span class="o">=</span><span class="n">scope</span><span class="p">,</span> <span class="n">expired</span><span class="o">=</span><span class="n">expired</span><span class="p">)</span>

<span class="k">return</span> <span class="n">msg</span> <span class="k">if</span> <span class="n">msg</span> <span class="k">else</span> <span class="n">message</span><span class="o">.</span><span class="n">Identity</span><span class="p">(</span><span class="s2">&quot;notification&quot;</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span></div>


<div class="viewcode-block" id="reply_notification"><a class="viewcode-back" href="../../../api.html#happypanda.interface.meta.reply_notification">[docs]</a><span class="k">def</span> <span class="nf">reply_notification</span><span class="p">(</span><span class="n">msg_id</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">action_values</span><span class="p">:</span> <span class="nb">dict</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Not ready yet...</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">s</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">if</span> <span class="n">constants</span><span class="o">.</span><span class="n">notification</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">constants</span><span class="o">.</span><span class="n">notification</span><span class="o">.</span><span class="n">reply</span><span class="p">(</span><span class="n">msg_id</span><span class="p">,</span> <span class="n">action_values</span><span class="p">)</span>
<span class="n">constants</span><span class="o">.</span><span class="n">notification</span><span class="o">.</span><span class="n">reply</span><span class="p">(</span><span class="n">msg_id</span><span class="p">,</span> <span class="n">action_values</span><span class="p">)</span>
<span class="n">s</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">return</span> <span class="n">message</span><span class="o">.</span><span class="n">Identity</span><span class="p">(</span><span class="s2">&quot;status&quot;</span><span class="p">,</span> <span class="n">s</span><span class="p">)</span></div>


<div class="viewcode-block" id="check_update"><a class="viewcode-back" href="../../../api.html#happypanda.interface.meta.check_update">[docs]</a><span class="k">def</span> <span class="nf">check_update</span><span class="p">(</span><span class="n">push</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Check for new release</span>
Expand All @@ -218,8 +220,8 @@ <h1>Source code for happypanda.interface.meta</h1><div class="highlight"><pre>

<span class="sd"> {</span>
<span class="sd"> &#39;url&#39; : str,</span>
<span class="sd"> &#39;changes&#39; : str,</span>
<span class="sd"> &#39;tag&#39; : str</span>
<span class="sd"> &#39;changes&#39; : str,</span>
<span class="sd"> }</span>
<span class="sd"> &quot;&quot;&quot;</span>

Expand All @@ -229,6 +231,7 @@ <h1>Source code for happypanda.interface.meta</h1><div class="highlight"><pre>
<span class="n">r</span> <span class="o">=</span> <span class="n">upd</span>
<span class="k">return</span> <span class="n">message</span><span class="o">.</span><span class="n">Identity</span><span class="p">(</span><span class="s1">&#39;update&#39;</span><span class="p">,</span> <span class="n">r</span><span class="p">)</span></div>


<div class="viewcode-block" id="update_application"><a class="viewcode-back" href="../../../api.html#happypanda.interface.meta.update_application">[docs]</a><span class="k">def</span> <span class="nf">update_application</span><span class="p">(</span><span class="n">download_url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">restart</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Update the application with a new release.</span>
Expand All @@ -245,6 +248,29 @@ <h1>Source code for happypanda.interface.meta</h1><div class="highlight"><pre>
<span class="n">upd</span> <span class="o">=</span> <span class="n">meta_cmd</span><span class="o">.</span><span class="n">UpdateApplication</span><span class="p">()</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">download_url</span><span class="p">,</span> <span class="n">restart</span><span class="p">)</span>
<span class="k">return</span> <span class="n">message</span><span class="o">.</span><span class="n">Identity</span><span class="p">(</span><span class="s1">&#39;update&#39;</span><span class="p">,</span> <span class="n">upd</span><span class="p">)</span></div>


<div class="viewcode-block" id="restart_application"><a class="viewcode-back" href="../../../api.html#happypanda.interface.meta.restart_application">[docs]</a><span class="k">def</span> <span class="nf">restart_application</span><span class="p">():</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Restart the application</span>

<span class="sd"> Returns:</span>
<span class="sd"> This function will not return</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">meta_cmd</span><span class="o">.</span><span class="n">RestartApplication</span><span class="p">()</span><span class="o">.</span><span class="n">run</span><span class="p">()</span>
<span class="k">return</span> <span class="n">message</span><span class="o">.</span><span class="n">Identity</span><span class="p">(</span><span class="s1">&#39;status&#39;</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span></div>


<div class="viewcode-block" id="shutdown_application"><a class="viewcode-back" href="../../../api.html#happypanda.interface.meta.shutdown_application">[docs]</a><span class="k">def</span> <span class="nf">shutdown_application</span><span class="p">():</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Shutdown the application</span>

<span class="sd"> Returns:</span>
<span class="sd"> This function will not return</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">meta_cmd</span><span class="o">.</span><span class="n">ShutdownApplication</span><span class="p">()</span><span class="o">.</span><span class="n">run</span><span class="p">()</span>
<span class="k">return</span> <span class="n">message</span><span class="o">.</span><span class="n">Identity</span><span class="p">(</span><span class="s1">&#39;status&#39;</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span></div>


<div class="viewcode-block" id="get_version"><a class="viewcode-back" href="../../../api.html#happypanda.interface.meta.get_version">[docs]</a><span class="k">def</span> <span class="nf">get_version</span><span class="p">():</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Get version of components: &#39;core&#39;, &#39;db&#39; and &#39;torrent&#39;</span>
Expand Down
6 changes: 3 additions & 3 deletions docs/_modules/happypanda/interface/settings.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>happypanda.interface.settings &#8212; Happypanda X 0.0.1#110 documentation</title>
<title>happypanda.interface.settings &#8212; Happypanda X 0.0.2#111 documentation</title>

<link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '0.0.1#110',
VERSION: '0.0.2#111',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
Expand Down Expand Up @@ -52,7 +52,7 @@
</button>
<a class="navbar-brand" href="../../../index.html">
Happypanda X</a>
<span class="navbar-text navbar-version pull-left"><b>0.0.1#110</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.0.2#111</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
6 changes: 3 additions & 3 deletions docs/_modules/happypanda/interface/tag.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>happypanda.interface.tag &#8212; Happypanda X 0.0.1#110 documentation</title>
<title>happypanda.interface.tag &#8212; Happypanda X 0.0.2#111 documentation</title>

<link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '0.0.1#110',
VERSION: '0.0.2#111',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
Expand Down Expand Up @@ -52,7 +52,7 @@
</button>
<a class="navbar-brand" href="../../../index.html">
Happypanda X</a>
<span class="navbar-text navbar-version pull-left"><b>0.0.1#110</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.0.2#111</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
6 changes: 3 additions & 3 deletions docs/_modules/happypanda/interface/ui.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>happypanda.interface.ui &#8212; Happypanda X 0.0.1#110 documentation</title>
<title>happypanda.interface.ui &#8212; Happypanda X 0.0.2#111 documentation</title>

<link rel="stylesheet" href="../../../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '0.0.1#110',
VERSION: '0.0.2#111',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
Expand Down Expand Up @@ -52,7 +52,7 @@
</button>
<a class="navbar-brand" href="../../../index.html">
Happypanda X</a>
<span class="navbar-text navbar-version pull-left"><b>0.0.1#110</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.0.2#111</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
6 changes: 3 additions & 3 deletions docs/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Overview: module code &#8212; Happypanda X 0.0.1#110 documentation</title>
<title>Overview: module code &#8212; Happypanda X 0.0.2#111 documentation</title>

<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
Expand All @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.0.1#110',
VERSION: '0.0.2#111',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
Expand Down Expand Up @@ -52,7 +52,7 @@
</button>
<a class="navbar-brand" href="../index.html">
Happypanda X</a>
<span class="navbar-text navbar-version pull-left"><b>0.0.1#110</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.0.2#111</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down

0 comments on commit ec541c6

Please sign in to comment.