Skip to content

Commit cad164f

Browse files
author
devbisme
committed
docs: Bumped version and updated documentation, history.
1 parent 3b28a89 commit cad164f

File tree

157 files changed

+620
-600
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

157 files changed

+620
-600
lines changed

‎HISTORY.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ History
44
-------
55

66

7-
2.0.1 (2024-12-04)
7+
2.0.1 (2024-12-11)
88
______________________
99
- Fixed #233: Imported `active_logger` into generate_schematic.py of KiCad 6, 7, 8.
10-
- Fix: Removed merging of multi-segment nets when generating netlists, XML, SVG, DOT because it removes pins from existing net references. Only merge for schematic generation or SPICE simulation.
10+
- Fixed #235: Removed merging of multi-segment nets when generating netlists, XML, SVG, DOT because it removes pins from existing net references. Only merge for schematic generation or SPICE simulation.
1111

1212

1313
2.0.0 (2024-11-27)

‎docs/api/doctrees/environment.pickle

8.78 KB
Binary file not shown.

‎docs/api/doctrees/rst_output/skidl.circuit.doctree

1.4 KB
Binary file not shown.

‎docs/api/html/.buildinfo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 4f594e0abdac623901e4f069d6f3c50d
3+
config: 7e2717891b081cc5a582d2a8dba94f83
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/api/html/_modules/index.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
<head>
77
<meta charset="utf-8" />
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Overview: module code &#8212; SKiDL 2.0.0 documentation</title>
9+
<title>Overview: module code &#8212; SKiDL 2.0.1 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
1111
<link rel="stylesheet" type="text/css" href="../_static/bizstyle.css?v=a66e137f" />
1212

13-
<script src="../_static/documentation_options.js?v=51b770b3"></script>
13+
<script src="../_static/documentation_options.js?v=f5cff4aa"></script>
1414
<script src="../_static/doctools.js?v=9a2dae69"></script>
1515
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../_static/bizstyle.js"></script>
@@ -32,7 +32,7 @@ <h3>Navigation</h3>
3232
<li class="right" >
3333
<a href="../py-modindex.html" title="Python Module Index"
3434
>modules</a> |</li>
35-
<li class="nav-item nav-item-0"><a href="../index.html">SKiDL 2.0.0 documentation</a> &#187;</li>
35+
<li class="nav-item nav-item-0"><a href="../index.html">SKiDL 2.0.1 documentation</a> &#187;</li>
3636
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
3737
</ul>
3838
</div>
@@ -134,7 +134,7 @@ <h3>Navigation</h3>
134134
<li class="right" >
135135
<a href="../py-modindex.html" title="Python Module Index"
136136
>modules</a> |</li>
137-
<li class="nav-item nav-item-0"><a href="../index.html">SKiDL 2.0.0 documentation</a> &#187;</li>
137+
<li class="nav-item nav-item-0"><a href="../index.html">SKiDL 2.0.1 documentation</a> &#187;</li>
138138
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
139139
</ul>
140140
</div>

‎docs/api/html/_modules/skidl/alias.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
<head>
77
<meta charset="utf-8" />
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>skidl.alias &#8212; SKiDL 2.0.0 documentation</title>
9+
<title>skidl.alias &#8212; SKiDL 2.0.1 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1111
<link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=a66e137f" />
1212

13-
<script src="../../_static/documentation_options.js?v=51b770b3"></script>
13+
<script src="../../_static/documentation_options.js?v=f5cff4aa"></script>
1414
<script src="../../_static/doctools.js?v=9a2dae69"></script>
1515
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../_static/bizstyle.js"></script>
@@ -32,7 +32,7 @@ <h3>Navigation</h3>
3232
<li class="right" >
3333
<a href="../../py-modindex.html" title="Python Module Index"
3434
>modules</a> |</li>
35-
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.0 documentation</a> &#187;</li>
35+
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.1 documentation</a> &#187;</li>
3636
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
3737
<li class="nav-item nav-item-this"><a href="">skidl.alias</a></li>
3838
</ul>
@@ -138,7 +138,7 @@ <h3>Navigation</h3>
138138
<li class="right" >
139139
<a href="../../py-modindex.html" title="Python Module Index"
140140
>modules</a> |</li>
141-
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.0 documentation</a> &#187;</li>
141+
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.1 documentation</a> &#187;</li>
142142
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
143143
<li class="nav-item nav-item-this"><a href="">skidl.alias</a></li>
144144
</ul>

‎docs/api/html/_modules/skidl/bus.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
<head>
77
<meta charset="utf-8" />
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>skidl.bus &#8212; SKiDL 2.0.0 documentation</title>
9+
<title>skidl.bus &#8212; SKiDL 2.0.1 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1111
<link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=a66e137f" />
1212

13-
<script src="../../_static/documentation_options.js?v=51b770b3"></script>
13+
<script src="../../_static/documentation_options.js?v=f5cff4aa"></script>
1414
<script src="../../_static/doctools.js?v=9a2dae69"></script>
1515
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../_static/bizstyle.js"></script>
@@ -32,7 +32,7 @@ <h3>Navigation</h3>
3232
<li class="right" >
3333
<a href="../../py-modindex.html" title="Python Module Index"
3434
>modules</a> |</li>
35-
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.0 documentation</a> &#187;</li>
35+
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.1 documentation</a> &#187;</li>
3636
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
3737
<li class="nav-item nav-item-this"><a href="">skidl.bus</a></li>
3838
</ul>
@@ -552,7 +552,7 @@ <h3>Navigation</h3>
552552
<li class="right" >
553553
<a href="../../py-modindex.html" title="Python Module Index"
554554
>modules</a> |</li>
555-
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.0 documentation</a> &#187;</li>
555+
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.1 documentation</a> &#187;</li>
556556
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
557557
<li class="nav-item nav-item-this"><a href="">skidl.bus</a></li>
558558
</ul>

‎docs/api/html/_modules/skidl/circuit.html

+14-6
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
<head>
77
<meta charset="utf-8" />
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>skidl.circuit &#8212; SKiDL 2.0.0 documentation</title>
9+
<title>skidl.circuit &#8212; SKiDL 2.0.1 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1111
<link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=a66e137f" />
1212

13-
<script src="../../_static/documentation_options.js?v=51b770b3"></script>
13+
<script src="../../_static/documentation_options.js?v=f5cff4aa"></script>
1414
<script src="../../_static/doctools.js?v=9a2dae69"></script>
1515
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../_static/bizstyle.js"></script>
@@ -32,7 +32,7 @@ <h3>Navigation</h3>
3232
<li class="right" >
3333
<a href="../../py-modindex.html" title="Python Module Index"
3434
>modules</a> |</li>
35-
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.0 documentation</a> &#187;</li>
35+
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.1 documentation</a> &#187;</li>
3636
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
3737
<li class="nav-item nav-item-this"><a href="">skidl.circuit</a></li>
3838
</ul>
@@ -510,7 +510,15 @@ <h1>Source code for skidl.circuit</h1><div class="highlight"><pre>
510510
<div class="viewcode-block" id="Circuit.merge_nets">
511511
<a class="viewcode-back" href="../../rst_output/skidl.circuit.html#skidl.circuit.Circuit.merge_nets">[docs]</a>
512512
<span class="k">def</span> <span class="nf">merge_nets</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
513-
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Merge multi-segment nets into a single net.&quot;&quot;&quot;</span>
513+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
514+
<span class="sd"> Merge multi-segment nets into a single net.</span>
515+
516+
<span class="sd"> Note: Multi-segment nets had to be merged or else tests to detect the</span>
517+
<span class="sd"> same net would fail in routing.py when generating schematics.</span>
518+
<span class="sd"> But as a result of merging, net variables can become invalid because of new merging.</span>
519+
<span class="sd"> Therefore, only do this when generating schematics so other generate_*() functions</span>
520+
<span class="sd"> will not be affected.</span>
521+
<span class="sd"> &quot;&quot;&quot;</span>
514522

515523
<span class="n">merged_nets</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
516524
<span class="k">for</span> <span class="n">net</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">nets</span><span class="p">:</span>
@@ -1112,6 +1120,7 @@ <h1>Source code for skidl.circuit</h1><div class="highlight"><pre>
11121120
<span class="n">skidl</span><span class="o">.</span><span class="n">empty_footprint_handler</span> <span class="o">=</span> <span class="n">_empty_footprint_handler</span>
11131121

11141122
<span class="bp">self</span><span class="o">.</span><span class="n">_preprocess</span><span class="p">()</span>
1123+
<span class="bp">self</span><span class="o">.</span><span class="n">merge_nets</span><span class="p">()</span> <span class="c1"># Merge nets or schematic routing will fail.</span>
11151124

11161125
<span class="n">tool</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">&quot;tool&quot;</span><span class="p">,</span> <span class="n">skidl</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">tool</span><span class="p">)</span>
11171126

@@ -1278,7 +1287,6 @@ <h1>Source code for skidl.circuit</h1><div class="highlight"><pre>
12781287
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Prepare the circuit for generating a netlist, PCB, etc.&quot;&quot;&quot;</span>
12791288

12801289
<span class="c1"># self._cull_unconnected_parts()</span>
1281-
<span class="bp">self</span><span class="o">.</span><span class="n">merge_nets</span><span class="p">()</span>
12821290
<span class="bp">self</span><span class="o">.</span><span class="n">_check_for_empty_footprints</span><span class="p">()</span>
12831291

12841292
<span class="nd">@property</span>
@@ -1323,7 +1331,7 @@ <h3>Navigation</h3>
13231331
<li class="right" >
13241332
<a href="../../py-modindex.html" title="Python Module Index"
13251333
>modules</a> |</li>
1326-
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.0 documentation</a> &#187;</li>
1334+
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.1 documentation</a> &#187;</li>
13271335
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
13281336
<li class="nav-item nav-item-this"><a href="">skidl.circuit</a></li>
13291337
</ul>

‎docs/api/html/_modules/skidl/config_.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
<head>
77
<meta charset="utf-8" />
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>skidl.config_ &#8212; SKiDL 2.0.0 documentation</title>
9+
<title>skidl.config_ &#8212; SKiDL 2.0.1 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1111
<link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=a66e137f" />
1212

13-
<script src="../../_static/documentation_options.js?v=51b770b3"></script>
13+
<script src="../../_static/documentation_options.js?v=f5cff4aa"></script>
1414
<script src="../../_static/doctools.js?v=9a2dae69"></script>
1515
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../_static/bizstyle.js"></script>
@@ -32,7 +32,7 @@ <h3>Navigation</h3>
3232
<li class="right" >
3333
<a href="../../py-modindex.html" title="Python Module Index"
3434
>modules</a> |</li>
35-
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.0 documentation</a> &#187;</li>
35+
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.1 documentation</a> &#187;</li>
3636
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
3737
<li class="nav-item nav-item-this"><a href="">skidl.config_</a></li>
3838
</ul>
@@ -209,7 +209,7 @@ <h3>Navigation</h3>
209209
<li class="right" >
210210
<a href="../../py-modindex.html" title="Python Module Index"
211211
>modules</a> |</li>
212-
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.0 documentation</a> &#187;</li>
212+
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.1 documentation</a> &#187;</li>
213213
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
214214
<li class="nav-item nav-item-this"><a href="">skidl.config_</a></li>
215215
</ul>

‎docs/api/html/_modules/skidl/erc.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
<head>
77
<meta charset="utf-8" />
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>skidl.erc &#8212; SKiDL 2.0.0 documentation</title>
9+
<title>skidl.erc &#8212; SKiDL 2.0.1 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1111
<link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=a66e137f" />
1212

13-
<script src="../../_static/documentation_options.js?v=51b770b3"></script>
13+
<script src="../../_static/documentation_options.js?v=f5cff4aa"></script>
1414
<script src="../../_static/doctools.js?v=9a2dae69"></script>
1515
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../_static/bizstyle.js"></script>
@@ -32,7 +32,7 @@ <h3>Navigation</h3>
3232
<li class="right" >
3333
<a href="../../py-modindex.html" title="Python Module Index"
3434
>modules</a> |</li>
35-
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.0 documentation</a> &#187;</li>
35+
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.1 documentation</a> &#187;</li>
3636
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
3737
<li class="nav-item nav-item-this"><a href="">skidl.erc</a></li>
3838
</ul>
@@ -200,7 +200,7 @@ <h3>Navigation</h3>
200200
<li class="right" >
201201
<a href="../../py-modindex.html" title="Python Module Index"
202202
>modules</a> |</li>
203-
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.0 documentation</a> &#187;</li>
203+
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.1 documentation</a> &#187;</li>
204204
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
205205
<li class="nav-item nav-item-this"><a href="">skidl.erc</a></li>
206206
</ul>

‎docs/api/html/_modules/skidl/geometry.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
<head>
77
<meta charset="utf-8" />
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>skidl.geometry &#8212; SKiDL 2.0.0 documentation</title>
9+
<title>skidl.geometry &#8212; SKiDL 2.0.1 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1111
<link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=a66e137f" />
1212

13-
<script src="../../_static/documentation_options.js?v=51b770b3"></script>
13+
<script src="../../_static/documentation_options.js?v=f5cff4aa"></script>
1414
<script src="../../_static/doctools.js?v=9a2dae69"></script>
1515
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../_static/bizstyle.js"></script>
@@ -32,7 +32,7 @@ <h3>Navigation</h3>
3232
<li class="right" >
3333
<a href="../../py-modindex.html" title="Python Module Index"
3434
>modules</a> |</li>
35-
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.0 documentation</a> &#187;</li>
35+
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.1 documentation</a> &#187;</li>
3636
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
3737
<li class="nav-item nav-item-this"><a href="">skidl.geometry</a></li>
3838
</ul>
@@ -653,7 +653,7 @@ <h3>Navigation</h3>
653653
<li class="right" >
654654
<a href="../../py-modindex.html" title="Python Module Index"
655655
>modules</a> |</li>
656-
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.0 documentation</a> &#187;</li>
656+
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.1 documentation</a> &#187;</li>
657657
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
658658
<li class="nav-item nav-item-this"><a href="">skidl.geometry</a></li>
659659
</ul>

‎docs/api/html/_modules/skidl/group.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
<head>
77
<meta charset="utf-8" />
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>skidl.group &#8212; SKiDL 2.0.0 documentation</title>
9+
<title>skidl.group &#8212; SKiDL 2.0.1 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
1111
<link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=a66e137f" />
1212

13-
<script src="../../_static/documentation_options.js?v=51b770b3"></script>
13+
<script src="../../_static/documentation_options.js?v=f5cff4aa"></script>
1414
<script src="../../_static/doctools.js?v=9a2dae69"></script>
1515
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../../_static/bizstyle.js"></script>
@@ -32,7 +32,7 @@ <h3>Navigation</h3>
3232
<li class="right" >
3333
<a href="../../py-modindex.html" title="Python Module Index"
3434
>modules</a> |</li>
35-
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.0 documentation</a> &#187;</li>
35+
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.1 documentation</a> &#187;</li>
3636
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
3737
<li class="nav-item nav-item-this"><a href="">skidl.group</a></li>
3838
</ul>
@@ -152,7 +152,7 @@ <h3>Navigation</h3>
152152
<li class="right" >
153153
<a href="../../py-modindex.html" title="Python Module Index"
154154
>modules</a> |</li>
155-
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.0 documentation</a> &#187;</li>
155+
<li class="nav-item nav-item-0"><a href="../../index.html">SKiDL 2.0.1 documentation</a> &#187;</li>
156156
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
157157
<li class="nav-item nav-item-this"><a href="">skidl.group</a></li>
158158
</ul>

0 commit comments

Comments
 (0)