summaryrefslogtreecommitdiff
path: root/code
diff options
context:
space:
mode:
authorunknown2019-06-03 14:56:53 +0530
committernilshah982019-06-17 22:34:34 +0530
commit89249e5003eccb07917d21788f6ce37e1de6d572 (patch)
tree3cf30e5211f8f5cbfafe7400b7b92670de00929a /code
parent1d4ee6b6c1254657c497673838922e746f339eca (diff)
downloadeSim-89249e5003eccb07917d21788f6ce37e1de6d572.tar.gz
eSim-89249e5003eccb07917d21788f6ce37e1de6d572.tar.bz2
eSim-89249e5003eccb07917d21788f6ce37e1de6d572.zip
sphinx documentation init
Diffstat (limited to 'code')
-rw-r--r--code/browser.rst5
-rw-r--r--code/frontEnd.rst4
-rw-r--r--code/kicadtoNgspice.rst4
-rw-r--r--code/modelEditor.rst5
-rw-r--r--code/modelEditor/modelEditor.rst6
-rw-r--r--code/ngspiceSimulation.rst4
-rw-r--r--code/projectManagement.rst12
-rw-r--r--code/projectManagement/.Kicad.rst.swpbin0 -> 12288 bytes
-rw-r--r--code/projectManagement/Kicad.rst6
-rw-r--r--code/projectManagement/Validation.rst6
-rw-r--r--code/projectManagement/Worker.rst6
-rw-r--r--code/projectManagement/newProject.rst6
-rw-r--r--code/projectManagement/openProject.rst6
-rw-r--r--code/subcircuit.rst4
14 files changed, 74 insertions, 0 deletions
diff --git a/code/browser.rst b/code/browser.rst
new file mode 100644
index 00000000..95ba113c
--- /dev/null
+++ b/code/browser.rst
@@ -0,0 +1,5 @@
+Browser Component
+=================
+
+.. toctree::
+
diff --git a/code/frontEnd.rst b/code/frontEnd.rst
new file mode 100644
index 00000000..4a7a9381
--- /dev/null
+++ b/code/frontEnd.rst
@@ -0,0 +1,4 @@
+Front-End Component
+===================
+
+.. toctree::
diff --git a/code/kicadtoNgspice.rst b/code/kicadtoNgspice.rst
new file mode 100644
index 00000000..746689da
--- /dev/null
+++ b/code/kicadtoNgspice.rst
@@ -0,0 +1,4 @@
+kicadtoNgspice Component
+========================
+
+.. toctree::
diff --git a/code/modelEditor.rst b/code/modelEditor.rst
new file mode 100644
index 00000000..092ef114
--- /dev/null
+++ b/code/modelEditor.rst
@@ -0,0 +1,5 @@
+Model Editor Component
+========================
+
+.. toctree::
+ modelEditor/modelEditor
diff --git a/code/modelEditor/modelEditor.rst b/code/modelEditor/modelEditor.rst
new file mode 100644
index 00000000..66f115e7
--- /dev/null
+++ b/code/modelEditor/modelEditor.rst
@@ -0,0 +1,6 @@
+Model Editor Component
+========================
+
+.. automodule:: modelEditor.ModelEditor
+ :members:
+
diff --git a/code/ngspiceSimulation.rst b/code/ngspiceSimulation.rst
new file mode 100644
index 00000000..1f7508bb
--- /dev/null
+++ b/code/ngspiceSimulation.rst
@@ -0,0 +1,4 @@
+ngspiceSimulation component
+===========================
+
+.. toctree::
diff --git a/code/projectManagement.rst b/code/projectManagement.rst
new file mode 100644
index 00000000..fd269525
--- /dev/null
+++ b/code/projectManagement.rst
@@ -0,0 +1,12 @@
+Project Explorer Component
+==========================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+ projectManagement/Kicad
+ projectManagement/Validation
+ projectManagement/Worker
+
+
diff --git a/code/projectManagement/.Kicad.rst.swp b/code/projectManagement/.Kicad.rst.swp
new file mode 100644
index 00000000..54a743a0
--- /dev/null
+++ b/code/projectManagement/.Kicad.rst.swp
Binary files differ
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..90950635
--- /dev/null
+++ b/code/subcircuit.rst
@@ -0,0 +1,4 @@
+Subcircuit component
+====================
+
+.. toctree::