From 89249e5003eccb07917d21788f6ce37e1de6d572 Mon Sep 17 00:00:00 2001 From: unknown Date: Mon, 3 Jun 2019 14:56:53 +0530 Subject: sphinx documentation init --- code/browser.rst | 5 +++++ code/frontEnd.rst | 4 ++++ code/kicadtoNgspice.rst | 4 ++++ code/modelEditor.rst | 5 +++++ code/modelEditor/modelEditor.rst | 6 ++++++ code/ngspiceSimulation.rst | 4 ++++ code/projectManagement.rst | 12 ++++++++++++ code/projectManagement/.Kicad.rst.swp | Bin 0 -> 12288 bytes code/projectManagement/Kicad.rst | 6 ++++++ code/projectManagement/Validation.rst | 6 ++++++ code/projectManagement/Worker.rst | 6 ++++++ code/projectManagement/newProject.rst | 6 ++++++ code/projectManagement/openProject.rst | 6 ++++++ code/subcircuit.rst | 4 ++++ 14 files changed, 74 insertions(+) create mode 100644 code/browser.rst create mode 100644 code/frontEnd.rst create mode 100644 code/kicadtoNgspice.rst create mode 100644 code/modelEditor.rst create mode 100644 code/modelEditor/modelEditor.rst create mode 100644 code/ngspiceSimulation.rst create mode 100644 code/projectManagement.rst create mode 100644 code/projectManagement/.Kicad.rst.swp create mode 100644 code/projectManagement/Kicad.rst create mode 100644 code/projectManagement/Validation.rst create mode 100644 code/projectManagement/Worker.rst create mode 100644 code/projectManagement/newProject.rst create mode 100644 code/projectManagement/openProject.rst create mode 100644 code/subcircuit.rst (limited to 'code') 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 Binary files /dev/null and b/code/projectManagement/.Kicad.rst.swp 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:: -- cgit