Skip to content

Commit

Permalink
[DOCs] Updated for release
Browse files Browse the repository at this point in the history
  • Loading branch information
@set-soft
set-soft committed Dec 15, 2022
1 parent caed9c0 commit d59534e
Show file tree
Hide file tree
Showing 60 changed files with 745 additions and 616 deletions.
Binary file modified docs/_build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/history.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/kicost.distributors.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/kicost.doctree
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/.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: 375b3b4efad9f5c43b65b104305e90e0
config: 89422b0a94bfa36c0fe8c1faa5a66fda
tags: 645f666f9bcd5a90fca523b33c5a78b7
6 changes: 3 additions & 3 deletions docs/_build/html/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; kicost 1.1.14 documentation</title>
<title>Overview: module code &#8212; kicost 1.1.15 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/classic.css" type="text/css" />

Expand All @@ -26,7 +26,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">kicost 1.1.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">kicost 1.1.15 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
</ul>
</div>
Expand Down Expand Up @@ -98,7 +98,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">kicost 1.1.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">kicost 1.1.15 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
</ul>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/_build/html/_modules/kicost/ansi.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kicost.ansi &#8212; kicost 1.1.14 documentation</title>
<title>kicost.ansi &#8212; kicost 1.1.15 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/classic.css" type="text/css" />

Expand All @@ -26,7 +26,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">kicost 1.1.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../index.html">kicost 1.1.15 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">kicost.ansi</a></li>
</ul>
Expand Down Expand Up @@ -182,7 +182,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">kicost 1.1.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../index.html">kicost 1.1.15 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">kicost.ansi</a></li>
</ul>
Expand Down
23 changes: 17 additions & 6 deletions docs/_build/html/_modules/kicost/config.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kicost.config &#8212; kicost 1.1.14 documentation</title>
<title>kicost.config &#8212; kicost 1.1.15 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/classic.css" type="text/css" />

Expand All @@ -26,7 +26,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">kicost 1.1.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../index.html">kicost 1.1.15 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">kicost.config</a></li>
</ul>
Expand Down Expand Up @@ -69,7 +69,7 @@ <h1>Source code for kicost.config</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">from</span> <span class="nn">.global_vars</span> <span class="kn">import</span> <span class="n">ERR_KICOSTCONFIG</span><span class="p">,</span> <span class="n">W_CONFIG</span><span class="p">,</span> <span class="n">BASE_OP_TYPES</span>
<span class="kn">from</span> <span class="nn">.distributors</span> <span class="kn">import</span> <span class="n">is_valid_api</span><span class="p">,</span> <span class="n">get_api_list</span><span class="p">,</span> <span class="n">get_api_valid_options</span>
<span class="kn">from</span> <span class="nn">.distributors</span> <span class="kn">import</span> <span class="n">is_valid_api</span><span class="p">,</span> <span class="n">get_api_list</span><span class="p">,</span> <span class="n">get_api_valid_options</span><span class="p">,</span> <span class="n">get_api_keys_to_hide</span><span class="p">,</span> <span class="n">hide_secrets</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">debug_detailed</span><span class="p">,</span> <span class="n">debug_obsessive</span><span class="p">,</span> <span class="n">debug_overview</span><span class="p">,</span> <span class="n">error</span><span class="p">,</span> <span class="n">warning</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">yaml</span>
Expand Down Expand Up @@ -180,6 +180,17 @@ <h1>Source code for kicost.config</h1><div class="highlight"><pre>
<span class="n">api_options</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">v</span></div>


<div class="viewcode-block" id="log_api_options"><a class="viewcode-back" href="../../kicost.html#kicost.config.log_api_options">[docs]</a><span class="k">def</span> <span class="nf">log_api_options</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">obsessive</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="n">dbg</span> <span class="o">=</span> <span class="n">debug_obsessive</span> <span class="k">if</span> <span class="n">obsessive</span> <span class="k">else</span> <span class="n">debug_detailed</span>
<span class="n">dbg</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">api_options</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">debug_obsessive</span><span class="p">(</span><span class="s1">&#39;- &#39;</span><span class="o">+</span><span class="n">k</span><span class="o">+</span><span class="s1">&#39;:&#39;</span><span class="p">)</span>
<span class="n">hide</span> <span class="o">=</span> <span class="n">get_api_keys_to_hide</span><span class="p">(</span><span class="n">k</span><span class="p">)</span>
<span class="k">for</span> <span class="n">k2</span><span class="p">,</span> <span class="n">v2</span> <span class="ow">in</span> <span class="n">v</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">v</span> <span class="o">=</span> <span class="n">v2</span> <span class="k">if</span> <span class="n">k2</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">hide</span> <span class="k">else</span> <span class="n">hide_secrets</span><span class="p">(</span><span class="n">v2</span><span class="p">)</span>
<span class="n">dbg</span><span class="p">(</span><span class="s1">&#39; - &#39;</span><span class="o">+</span><span class="n">k2</span><span class="o">+</span><span class="s1">&#39;: &#39;</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">v</span><span class="p">))</span></div>


<div class="viewcode-block" id="load_config"><a class="viewcode-back" href="../../kicost.html#kicost.config.load_config">[docs]</a><span class="k">def</span> <span class="nf">load_config</span><span class="p">(</span><span class="n">file</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">if</span> <span class="n">file</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s1">&#39;~&#39;</span><span class="p">,</span> <span class="s1">&#39;.config&#39;</span><span class="p">,</span> <span class="s1">&#39;kicost&#39;</span><span class="p">,</span> <span class="n">CONFIG_FILE</span><span class="p">))</span>
Expand All @@ -204,7 +215,7 @@ <h1>Source code for kicost.config</h1><div class="highlight"><pre>
<span class="n">parse_apis_section</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">warning</span><span class="p">(</span><span class="n">W_CONFIG</span><span class="p">,</span> <span class="s1">&#39;Unknown section `</span><span class="si">{}</span><span class="s1">` in config file&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">k</span><span class="p">))</span>
<span class="n">debug_obsessive</span><span class="p">(</span><span class="s1">&#39;Loaded API options </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">api_options</span><span class="p">))</span>
<span class="n">log_api_options</span><span class="p">(</span><span class="s1">&#39;Loaded API options&#39;</span><span class="p">,</span> <span class="n">obsessive</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">debug_overview</span><span class="p">(</span><span class="s1">&#39;No config file found (</span><span class="si">{}</span><span class="s1">)&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">file</span><span class="p">))</span>
<span class="c1"># Make sure all APIs are in the options</span>
Expand All @@ -226,7 +237,7 @@ <h1>Source code for kicost.config</h1><div class="highlight"><pre>
<span class="n">path</span> <span class="o">=</span> <span class="n">ops</span><span class="p">[</span><span class="s1">&#39;cache_path&#39;</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
<span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
<span class="n">debug_detailed</span><span class="p">(</span><span class="s1">&#39;API options with defaults </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">api_options</span><span class="p">))</span>
<span class="n">log_api_options</span><span class="p">(</span><span class="s1">&#39;API options with defaults&#39;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">api_options</span></div>
</pre></div>

Expand Down Expand Up @@ -259,7 +270,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">kicost 1.1.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../index.html">kicost 1.1.15 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">kicost.config</a></li>
</ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/_build/html/_modules/kicost/currency_converter/currency_converter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kicost.currency_converter.currency_converter &#8212; kicost 1.1.14 documentation</title>
<title>kicost.currency_converter.currency_converter &#8212; kicost 1.1.15 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/classic.css" type="text/css" />

Expand All @@ -26,7 +26,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">kicost 1.1.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">kicost 1.1.15 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">kicost.currency_converter.currency_converter</a></li>
</ul>
Expand Down Expand Up @@ -170,7 +170,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">kicost 1.1.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">kicost 1.1.15 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">kicost.currency_converter.currency_converter</a></li>
</ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/_build/html/_modules/kicost/currency_converter/download_rates.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kicost.currency_converter.download_rates &#8212; kicost 1.1.14 documentation</title>
<title>kicost.currency_converter.download_rates &#8212; kicost 1.1.15 documentation</title>
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/classic.css" type="text/css" />

Expand All @@ -26,7 +26,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">kicost 1.1.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">kicost 1.1.15 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">kicost.currency_converter.download_rates</a></li>
</ul>
Expand Down Expand Up @@ -115,7 +115,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">kicost 1.1.14 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">kicost 1.1.15 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">kicost.currency_converter.download_rates</a></li>
</ul>
Expand Down
Loading

0 comments on commit d59534e

Please sign in to comment.