summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authornilshah982019-06-11 14:46:15 +0530
committernilshah982019-06-17 22:34:34 +0530
commit61f729c35da3120781d001a390b55e1941d14925 (patch)
tree804d1f367497b18d2efe7ce0f59ed24d78b0bd3d
parent89249e5003eccb07917d21788f6ce37e1de6d572 (diff)
downloadeSim-61f729c35da3120781d001a390b55e1941d14925.tar.gz
eSim-61f729c35da3120781d001a390b55e1941d14925.tar.bz2
eSim-61f729c35da3120781d001a390b55e1941d14925.zip
rst files added for all components
-rw-r--r--code/browser.rst4
-rw-r--r--code/browser/UserManual.rst6
-rw-r--r--code/browser/Welcome.rst5
-rw-r--r--code/frontEnd.rst8
-rw-r--r--code/frontEnd/Application.rst5
-rw-r--r--code/frontEnd/DockArea.rst5
-rw-r--r--code/frontEnd/ProjectExplorer.rst5
-rw-r--r--code/frontEnd/Workspace.rst5
-rw-r--r--code/kicadtoNgspice.rst13
-rw-r--r--code/kicadtoNgspice/Analysis.rst5
-rw-r--r--code/kicadtoNgspice/Convert.rst5
-rw-r--r--code/kicadtoNgspice/DeviceModel.rst5
-rw-r--r--code/kicadtoNgspice/KicadtoNgspice.rst5
-rw-r--r--code/kicadtoNgspice/Model.rst5
-rw-r--r--code/kicadtoNgspice/Processing.rst5
-rw-r--r--code/kicadtoNgspice/Source.rst5
-rw-r--r--code/kicadtoNgspice/SubcircuitTab.rst6
-rw-r--r--code/kicadtoNgspice/TrackWidget.rst5
-rw-r--r--code/modelEditor.rst3
-rw-r--r--code/ngspiceSimulation.rst6
-rw-r--r--code/ngspiceSimulation/NgspiceWidget.rst5
-rw-r--r--code/ngspiceSimulation/pythonPlotting.rst5
-rw-r--r--code/projectManagement.rst2
-rw-r--r--code/projectManagement/.Kicad.rst.swpbin12288 -> 0 bytes
-rw-r--r--code/subcircuit.rst5
-rw-r--r--code/subcircuit/Subcircuit.rst6
-rw-r--r--code/subcircuit/convertSub.rst5
-rw-r--r--code/subcircuit/newSub.rst5
-rw-r--r--code/subcircuit/openSub.rst6
29 files changed, 149 insertions, 1 deletions
diff --git a/code/browser.rst b/code/browser.rst
index 95ba113c..da2c0981 100644
--- a/code/browser.rst
+++ b/code/browser.rst
@@ -2,4 +2,8 @@ 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
index 4a7a9381..69cfb06f 100644
--- a/code/frontEnd.rst
+++ b/code/frontEnd.rst
@@ -2,3 +2,11 @@ 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..8f45816f
--- /dev/null
+++ b/code/frontEnd/Workspace.rst
@@ -0,0 +1,5 @@
+Workspace Component
+===================
+
+.. automodule:: frontEnd.Workspace
+ :pmembers:
diff --git a/code/kicadtoNgspice.rst b/code/kicadtoNgspice.rst
index 746689da..f5cdab7f 100644
--- a/code/kicadtoNgspice.rst
+++ b/code/kicadtoNgspice.rst
@@ -2,3 +2,16 @@ 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
index 092ef114..2f8fc77e 100644
--- a/code/modelEditor.rst
+++ b/code/modelEditor.rst
@@ -2,4 +2,7 @@ Model Editor Component
========================
.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
modelEditor/modelEditor
diff --git a/code/ngspiceSimulation.rst b/code/ngspiceSimulation.rst
index 1f7508bb..af1e4e75 100644
--- a/code/ngspiceSimulation.rst
+++ b/code/ngspiceSimulation.rst
@@ -2,3 +2,9 @@ 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
index fd269525..ecf01006 100644
--- a/code/projectManagement.rst
+++ b/code/projectManagement.rst
@@ -1,4 +1,4 @@
-Project Explorer Component
+Project Management Component
==========================
.. toctree::
diff --git a/code/projectManagement/.Kicad.rst.swp b/code/projectManagement/.Kicad.rst.swp
deleted file mode 100644
index 54a743a0..00000000
--- a/code/projectManagement/.Kicad.rst.swp
+++ /dev/null
Binary files differ
diff --git a/code/subcircuit.rst b/code/subcircuit.rst
index 90950635..ad792b42 100644
--- a/code/subcircuit.rst
+++ b/code/subcircuit.rst
@@ -2,3 +2,8 @@ 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:
+