Skip to content

Commit

Permalink
[DOCs] Updated
Browse files Browse the repository at this point in the history
  • Loading branch information
@set-soft
set-soft committed Dec 14, 2022
1 parent 0c89e24 commit 8cd1476
Show file tree
Hide file tree
Showing 68 changed files with 4,975 additions and 1,327 deletions.
Binary file modified docs/_build/doctrees/authors.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/configuration.doctree
View file
Binary file not shown.
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: 98975195270f5a3a93724924d432eaa5
config: 375b3b4efad9f5c43b65b104305e90e0
tags: 645f666f9bcd5a90fca523b33c5a78b7
14 changes: 10 additions & 4 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.13 documentation</title>
<title>Overview: module code &#8212; kicost 1.1.14 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.13 documentation</a> &#187;</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-this"><a href="">Overview: module code</a></li>
</ul>
</div>
Expand All @@ -42,10 +42,16 @@ <h1>All modules for which code is available</h1>
<li><a href="kicost/currency_converter/currency_converter.html">kicost.currency_converter.currency_converter</a></li>
<li><a href="kicost/currency_converter/download_rates.html">kicost.currency_converter.download_rates</a></li>
<li><a href="kicost/distributors.html">kicost.distributors</a></li>
<ul><li><a href="kicost/distributors/api_octopart.html">kicost.distributors.api_octopart</a></li>
<ul><li><a href="kicost/distributors/api_digikey.html">kicost.distributors.api_digikey</a></li>
<li><a href="kicost/distributors/api_element14.html">kicost.distributors.api_element14</a></li>
<li><a href="kicost/distributors/api_mouser.html">kicost.distributors.api_mouser</a></li>
<li><a href="kicost/distributors/api_nexar.html">kicost.distributors.api_nexar</a></li>
<li><a href="kicost/distributors/api_partinfo_kitspace.html">kicost.distributors.api_partinfo_kitspace</a></li>
<li><a href="kicost/distributors/api_tme.html">kicost.distributors.api_tme</a></li>
<li><a href="kicost/distributors/dist_local_template.html">kicost.distributors.dist_local_template</a></li>
<li><a href="kicost/distributors/distributor.html">kicost.distributors.distributor</a></li>
<li><a href="kicost/distributors/distributors_info.html">kicost.distributors.distributors_info</a></li>
<li><a href="kicost/distributors/log__.html">kicost.distributors.log__</a></li>
</ul><li><a href="kicost/edas.html">kicost.edas</a></li>
<ul><li><a href="kicost/edas/eda_altium.html">kicost.edas.eda_altium</a></li>
<li><a href="kicost/edas/eda_kicad.html">kicost.edas.eda_kicad</a></li>
Expand Down Expand Up @@ -92,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.13 documentation</a> &#187;</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-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.13 documentation</title>
<title>kicost.ansi &#8212; kicost 1.1.14 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.13 documentation</a> &#187;</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-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.13 documentation</a> &#187;</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-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
12 changes: 9 additions & 3 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.13 documentation</title>
<title>kicost.config &#8212; kicost 1.1.14 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.13 documentation</a> &#187;</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-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 @@ -207,9 +207,15 @@ <h1>Source code for kicost.config</h1><div class="highlight"><pre>
<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="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>
<span class="k">for</span> <span class="n">api</span> <span class="ow">in</span> <span class="n">get_api_list</span><span class="p">():</span>
<span class="k">if</span> <span class="n">api</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">api_options</span><span class="p">:</span>
<span class="n">api_options</span><span class="p">[</span><span class="n">api</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">return</span> <span class="n">api_options</span></div>


<div class="viewcode-block" id="fill_missing_with_defaults"><a class="viewcode-back" href="../../kicost.html#kicost.config.fill_missing_with_defaults">[docs]</a><span class="k">def</span> <span class="nf">fill_missing_with_defaults</span><span class="p">():</span>
<span class="k">for</span> <span class="n">api</span> <span class="ow">in</span> <span class="n">get_api_list</span><span class="p">():</span>
<span class="c1"># Transfer defaults</span>
<span class="n">ops</span> <span class="o">=</span> <span class="n">api_options</span><span class="p">[</span><span class="n">api</span><span class="p">]</span>
<span class="k">if</span> <span class="s1">&#39;cache_ttl&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">ops</span><span class="p">:</span>
Expand Down Expand Up @@ -253,7 +259,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.13 documentation</a> &#187;</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-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.13 documentation</title>
<title>kicost.currency_converter.currency_converter &#8212; kicost 1.1.14 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.13 documentation</a> &#187;</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-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.13 documentation</a> &#187;</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-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.13 documentation</title>
<title>kicost.currency_converter.download_rates &#8212; kicost 1.1.14 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.13 documentation</a> &#187;</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-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.13 documentation</a> &#187;</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-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
6 changes: 3 additions & 3 deletions docs/_build/html/_modules/kicost/distributors.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.distributors &#8212; kicost 1.1.13 documentation</title>
<title>kicost.distributors &#8212; kicost 1.1.14 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.13 documentation</a> &#187;</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-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">kicost.distributors</a></li>
</ul>
Expand Down Expand Up @@ -188,7 +188,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.13 documentation</a> &#187;</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-1"><a href="../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">kicost.distributors</a></li>
</ul>
Expand Down
Loading

0 comments on commit 8cd1476

Please sign in to comment.