diff options
Diffstat (limited to 'code')
34 files changed, 224 insertions, 0 deletions
diff --git a/code/browser.rst b/code/browser.rst new file mode 100644 index 00000000..da2c0981 --- /dev/null +++ b/code/browser.rst @@ -0,0 +1,9 @@ +Browser Component +================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + browser/UserManual + browser/Welcome diff --git a/code/browser/UserManual.rst b/code/browser/UserManual.rst new file mode 100644 index 00000000..2595bfe6 --- /dev/null +++ b/code/browser/UserManual.rst @@ -0,0 +1,6 @@ +User Manual Component +===================== + +.. automodule:: browser.UserManual + :members: + diff --git a/code/browser/Welcome.rst b/code/browser/Welcome.rst new file mode 100644 index 00000000..e2af55d4 --- /dev/null +++ b/code/browser/Welcome.rst @@ -0,0 +1,5 @@ +Welcome Component +================= + +.. automodule:: browser.Welcome + :members: diff --git a/code/frontEnd.rst b/code/frontEnd.rst new file mode 100644 index 00000000..69cfb06f --- /dev/null +++ b/code/frontEnd.rst @@ -0,0 +1,12 @@ +Front-End Component +=================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + frontEnd/Application + frontEnd/DockArea + frontEnd/ProjectExplorer + frontEnd/Workspace + diff --git a/code/frontEnd/Application.rst b/code/frontEnd/Application.rst new file mode 100644 index 00000000..4eb41d17 --- /dev/null +++ b/code/frontEnd/Application.rst @@ -0,0 +1,5 @@ +Application Component +===================== + +.. automodule:: frontEnd.Application + :members: diff --git a/code/frontEnd/DockArea.rst b/code/frontEnd/DockArea.rst new file mode 100644 index 00000000..31fdd742 --- /dev/null +++ b/code/frontEnd/DockArea.rst @@ -0,0 +1,5 @@ +Dock Area Component +=================== + +.. automodule:: frontEnd.DockArea + :members: diff --git a/code/frontEnd/ProjectExplorer.rst b/code/frontEnd/ProjectExplorer.rst new file mode 100644 index 00000000..33dec0c0 --- /dev/null +++ b/code/frontEnd/ProjectExplorer.rst @@ -0,0 +1,5 @@ +Project Explorer Component +========================== + +.. automodule:: frontEnd.ProjectExplorer + :members: diff --git a/code/frontEnd/Workspace.rst b/code/frontEnd/Workspace.rst new file mode 100644 index 00000000..8722c745 --- /dev/null +++ b/code/frontEnd/Workspace.rst @@ -0,0 +1,5 @@ +Workspace Component +=================== + +.. automodule:: frontEnd.Workspace + :members: diff --git a/code/kicadtoNgspice.rst b/code/kicadtoNgspice.rst new file mode 100644 index 00000000..f5cdab7f --- /dev/null +++ b/code/kicadtoNgspice.rst @@ -0,0 +1,17 @@ +kicadtoNgspice Component +======================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + kicadtoNgspice/Analysis + kicadtoNgspice/Convert + kicadtoNgspice/DeviceModel + kicadtoNgspice/KicadtoNgspice + kicadtoNgspice/Model + kicadtoNgspice/Processing + kicadtoNgspice/Source + kicadtoNgspice/SubcircuitTab + kicadtoNgspice/TrackWidget + diff --git a/code/kicadtoNgspice/Analysis.rst b/code/kicadtoNgspice/Analysis.rst new file mode 100644 index 00000000..4c41a8d9 --- /dev/null +++ b/code/kicadtoNgspice/Analysis.rst @@ -0,0 +1,5 @@ +Analysis Component +================== + +.. automodule:: kicadtoNgspice.Analysis + :members: diff --git a/code/kicadtoNgspice/Convert.rst b/code/kicadtoNgspice/Convert.rst new file mode 100644 index 00000000..0ed795a6 --- /dev/null +++ b/code/kicadtoNgspice/Convert.rst @@ -0,0 +1,5 @@ +Convert Component +================= + +.. automodule:: kicadtoNgspice.Convert + :members: diff --git a/code/kicadtoNgspice/DeviceModel.rst b/code/kicadtoNgspice/DeviceModel.rst new file mode 100644 index 00000000..b59c3ee2 --- /dev/null +++ b/code/kicadtoNgspice/DeviceModel.rst @@ -0,0 +1,5 @@ +Device Model Component +====================== + +.. automodule:: kicadtoNgspice.DeviceModel + :members: diff --git a/code/kicadtoNgspice/KicadtoNgspice.rst b/code/kicadtoNgspice/KicadtoNgspice.rst new file mode 100644 index 00000000..23115483 --- /dev/null +++ b/code/kicadtoNgspice/KicadtoNgspice.rst @@ -0,0 +1,5 @@ +KicadtoNgspice component +======================== + +.. automodule:: kicadtoNgspice.KicadtoNgspice + :members: diff --git a/code/kicadtoNgspice/Model.rst b/code/kicadtoNgspice/Model.rst new file mode 100644 index 00000000..122c7d21 --- /dev/null +++ b/code/kicadtoNgspice/Model.rst @@ -0,0 +1,5 @@ +Model Component +=============== + +.. automodule:: kicadtoNgspice.Model + :members: diff --git a/code/kicadtoNgspice/Processing.rst b/code/kicadtoNgspice/Processing.rst new file mode 100644 index 00000000..1c6fc092 --- /dev/null +++ b/code/kicadtoNgspice/Processing.rst @@ -0,0 +1,5 @@ +Processing Component +==================== + +.. automodule:: kicadtoNgspice.Processing + :members: diff --git a/code/kicadtoNgspice/Source.rst b/code/kicadtoNgspice/Source.rst new file mode 100644 index 00000000..875c5ff8 --- /dev/null +++ b/code/kicadtoNgspice/Source.rst @@ -0,0 +1,5 @@ +Source Component +================ + +.. automodule:: kicadtoNgspice.Source + :members: diff --git a/code/kicadtoNgspice/SubcircuitTab.rst b/code/kicadtoNgspice/SubcircuitTab.rst new file mode 100644 index 00000000..eb301dcb --- /dev/null +++ b/code/kicadtoNgspice/SubcircuitTab.rst @@ -0,0 +1,6 @@ +Subcircuit Tab component +======================== + + +.. automodule:: kicadtoNgspice.SubcircuitTab + :members: diff --git a/code/kicadtoNgspice/TrackWidget.rst b/code/kicadtoNgspice/TrackWidget.rst new file mode 100644 index 00000000..78f1a2c4 --- /dev/null +++ b/code/kicadtoNgspice/TrackWidget.rst @@ -0,0 +1,5 @@ +Track Widget Component +====================== + +.. automodule:: kicadtoNgspice.TrackWidget + :members: diff --git a/code/modelEditor.rst b/code/modelEditor.rst new file mode 100644 index 00000000..2f8fc77e --- /dev/null +++ b/code/modelEditor.rst @@ -0,0 +1,8 @@ +Model Editor Component +======================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + modelEditor/modelEditor diff --git a/code/modelEditor/modelEditor.rst b/code/modelEditor/modelEditor.rst new file mode 100644 index 00000000..61aa5300 --- /dev/null +++ b/code/modelEditor/modelEditor.rst @@ -0,0 +1,6 @@ +Model Editor Component +======================== + +.. automodule:: modelEditor.ModelEditor + :members: +
\ No newline at end of file diff --git a/code/ngspiceSimulation.rst b/code/ngspiceSimulation.rst new file mode 100644 index 00000000..af1e4e75 --- /dev/null +++ b/code/ngspiceSimulation.rst @@ -0,0 +1,10 @@ +ngspiceSimulation component +=========================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + ngspiceSimulation/NgspiceWidget + ngspiceSimulation/pythonPlotting + diff --git a/code/ngspiceSimulation/NgspiceWidget.rst b/code/ngspiceSimulation/NgspiceWidget.rst new file mode 100644 index 00000000..753d3528 --- /dev/null +++ b/code/ngspiceSimulation/NgspiceWidget.rst @@ -0,0 +1,5 @@ +Ngspice Widget Component +======================== + +.. automodule:: ngspiceSimulation.NgspiceWidget + :members: diff --git a/code/ngspiceSimulation/pythonPlotting.rst b/code/ngspiceSimulation/pythonPlotting.rst new file mode 100644 index 00000000..bfb9a3b6 --- /dev/null +++ b/code/ngspiceSimulation/pythonPlotting.rst @@ -0,0 +1,5 @@ +Python Plotting component +========================= + +.. automodule:: ngspiceSimulation.pythonPlotting + :members: diff --git a/code/projectManagement.rst b/code/projectManagement.rst new file mode 100644 index 00000000..1122fc91 --- /dev/null +++ b/code/projectManagement.rst @@ -0,0 +1,14 @@ +Project Management Component +============================ + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + projectManagement/Kicad + projectManagement/Validation + projectManagement/Worker + projectManagement/openProject + projectManagement/newProject + + diff --git a/code/projectManagement/Kicad.rst b/code/projectManagement/Kicad.rst new file mode 100644 index 00000000..0b2dd07d --- /dev/null +++ b/code/projectManagement/Kicad.rst @@ -0,0 +1,6 @@ +Open Kicad Schematic Button +=========================== + +.. automodule:: projManagement.Kicad + :members: + diff --git a/code/projectManagement/Validation.rst b/code/projectManagement/Validation.rst new file mode 100644 index 00000000..24486fa9 --- /dev/null +++ b/code/projectManagement/Validation.rst @@ -0,0 +1,6 @@ +Validation Helper Function +=========================== + +.. automodule:: projManagement.Validation + :members: + diff --git a/code/projectManagement/Worker.rst b/code/projectManagement/Worker.rst new file mode 100644 index 00000000..c3c5cc6b --- /dev/null +++ b/code/projectManagement/Worker.rst @@ -0,0 +1,6 @@ +Helper Worker Function +=========================== + +.. automodule:: projManagement.Worker + :members: + diff --git a/code/projectManagement/newProject.rst b/code/projectManagement/newProject.rst new file mode 100644 index 00000000..9d3e5632 --- /dev/null +++ b/code/projectManagement/newProject.rst @@ -0,0 +1,6 @@ +New Project Function +=========================== + +.. automodule:: projManagement.newProject + :members: + diff --git a/code/projectManagement/openProject.rst b/code/projectManagement/openProject.rst new file mode 100644 index 00000000..2a11cd72 --- /dev/null +++ b/code/projectManagement/openProject.rst @@ -0,0 +1,6 @@ +Open Project Button +=========================== + +.. automodule:: projManagement.openProject + :members: + diff --git a/code/subcircuit.rst b/code/subcircuit.rst new file mode 100644 index 00000000..ad792b42 --- /dev/null +++ b/code/subcircuit.rst @@ -0,0 +1,9 @@ +Subcircuit component +==================== + +.. toctree:: + subcircuit/convertSub + subcircuit/newSub + subcircuit/openSub + subcircuit/Subcircuit + diff --git a/code/subcircuit/Subcircuit.rst b/code/subcircuit/Subcircuit.rst new file mode 100644 index 00000000..ded745d9 --- /dev/null +++ b/code/subcircuit/Subcircuit.rst @@ -0,0 +1,6 @@ +Subcircuit component +==================== + +.. automodule:: subcircuit.Subcircuit + :members: + diff --git a/code/subcircuit/convertSub.rst b/code/subcircuit/convertSub.rst new file mode 100644 index 00000000..0807ca70 --- /dev/null +++ b/code/subcircuit/convertSub.rst @@ -0,0 +1,5 @@ +Convert Subcircuit component +============================ + +.. automodule:: subcircuit.convertSub + :members: diff --git a/code/subcircuit/newSub.rst b/code/subcircuit/newSub.rst new file mode 100644 index 00000000..512d6887 --- /dev/null +++ b/code/subcircuit/newSub.rst @@ -0,0 +1,5 @@ +New subcircuit component +======================== + +.. automodule:: subcircuit.newSub + :members: diff --git a/code/subcircuit/openSub.rst b/code/subcircuit/openSub.rst new file mode 100644 index 00000000..ffb1722b --- /dev/null +++ b/code/subcircuit/openSub.rst @@ -0,0 +1,6 @@ +Open subcircuit component +========================= + +.. automodule:: subcircuit.openSub + :members: + |