Skip to content

Commit

Permalink
Updated the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
set-soft committed May 10, 2021
1 parent d124038 commit f78aebb
Show file tree
Hide file tree
Showing 75 changed files with 19,666 additions and 26,946 deletions.
3 changes: 1 addition & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,7 @@ docs:
sphinx-apidoc -o docs/ kicost
$(MAKE) -C docs clean
$(MAKE) -C docs html
open docs/_build/html/index.html
$(MAKE) -C ./docs/make singlehtml
$(MAKE) -C docs singlehtml

release-test: clean
$(PYTHON) setup.py sdist
Expand Down
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/history.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/_build/doctrees/kicost.distributors.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/kicost.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/kicost.edas.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/usage.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/.buildinfo
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: 550406fd2199fbd56aa8adc80f1b625e
config: 90dc6b68ee69ac40d7d99589cbcc44f9
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added docs/_build/html/_images/kitspace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 25 additions & 17 deletions docs/_build/html/_modules/index.html
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; kicost 1.1.5 documentation</title>
<link rel="stylesheet" href="../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/classic.css" type="text/css" />

<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>

<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
Expand All @@ -26,7 +26,8 @@ <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.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">kicost 1.1.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
</ul>
</div>

Expand All @@ -36,26 +37,32 @@ <h3>Navigation</h3>
<div class="body" role="main">

<h1>All modules for which code is available</h1>
<ul><li><a href="kicost/distributors.html">kicost.distributors</a></li>
<ul><li><a href="kicost.html">kicost</a></li>
<ul><li><a href="kicost/ansi.html">kicost.ansi</a></li>
<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>
<li><a href="kicost/distributors/api_partinfo_kitspace.html">kicost.distributors.api_partinfo_kitspace</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>
</ul><li><a href="kicost/edas/eda_altium.html">kicost.edas.eda_altium</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>
<li><a href="kicost/edas/generic_csv.html">kicost.edas.generic_csv</a></li>
<li><a href="kicost/edas/tools.html">kicost.edas.tools</a></li>
<li><a href="kicost/global_vars.html">kicost.global_vars</a></li>
</ul><li><a href="kicost/global_vars.html">kicost.global_vars</a></li>
<li><a href="kicost/kicad_config.html">kicost.kicad_config</a></li>
<li><a href="kicost/kicost.html">kicost.kicost</a></li>
<li><a href="kicost/kicost_config.html">kicost.kicost_config</a></li>
<li><a href="kicost/kicost_gui.html">kicost.kicost_gui</a></li>
<li><a href="kicost/kicost_gui_wxFormBuilder.html">kicost.kicost_gui_wxFormBuilder</a></li>
<li><a href="kicost/kicost_kicadplugin.html">kicost.kicost_kicadplugin</a></li>
<li><a href="kicost/log.html">kicost.log</a></li>
<li><a href="kicost/sexpdata.html">kicost.sexpdata</a></li>
<li><a href="kicost/spreadsheet.html">kicost.spreadsheet</a></li>
<li><a href="kicost/wxAnyThread.html">kicost.wxAnyThread</a></li>
</ul>
</ul></ul>

<div class="clearer"></div>
</div>
</div>
</div>
Expand All @@ -70,7 +77,7 @@ <h3 id="searchlabel">Quick search</h3>
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
Expand All @@ -84,12 +91,13 @@ <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.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">kicost 1.1.5 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2015, XESS Corporation.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.2.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3.
</div>
</body>
</html>
106 changes: 106 additions & 0 deletions docs/_build/html/_modules/kicost.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@

<!DOCTYPE html>

<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kicost &#8212; kicost 1.1.5 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/classic.css" type="text/css" />

<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>

<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<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.5 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</a></li>
</ul>
</div>

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">

<h1>Source code for kicost</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>

<span class="n">__author__</span> <span class="o">=</span> <span class="s1">&#39;XESS Corporation&#39;</span>
<span class="n">__email__</span> <span class="o">=</span> <span class="s1">&#39;[email protected]&#39;</span>
<span class="c1"># Export .version.__version__ as a module version</span>
<span class="kn">from</span> <span class="nn">.version</span> <span class="kn">import</span> <span class="n">__version__</span> <span class="c1"># noqa: F401</span>


<span class="c1"># Class for storing part group information.</span>
<div class="viewcode-block" id="PartGroup"><a class="viewcode-back" href="../kicost.html#kicost.PartGroup">[docs]</a><span class="k">class</span> <span class="nc">PartGroup</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&#39;&#39;&#39;@brief Class to group components.&#39;&#39;&#39;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># None by default, here to avoid try/except in the code</span>
<span class="bp">self</span><span class="o">.</span><span class="n">datasheet</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">lifecycle</span> <span class="o">=</span> <span class="kc">None</span>
<span class="c1"># Distributor data</span>
<span class="bp">self</span><span class="o">.</span><span class="n">part_num</span> <span class="o">=</span> <span class="p">{}</span> <span class="c1"># Distributor catalogue number.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">url</span> <span class="o">=</span> <span class="p">{}</span> <span class="c1"># Purchase distributor URL for the spefic part.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">price_tiers</span> <span class="o">=</span> <span class="p">{}</span> <span class="c1"># Price break tiers; [[qty1, price1][qty2, price2]...]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">qty_avail</span> <span class="o">=</span> <span class="p">{}</span> <span class="c1"># Available quantity.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">qty_increment</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">info_dist</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">currency</span> <span class="o">=</span> <span class="p">{}</span> <span class="c1"># Default currency.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">moq</span> <span class="o">=</span> <span class="p">{}</span> <span class="c1"># Minimum order quantity allowd by the distributor.</span></div>
</pre></div>

<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<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.5 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</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2015, XESS Corporation.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3.
</div>
</body>
</html>
Loading

0 comments on commit f78aebb

Please sign in to comment.