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 From 61f729c35da3120781d001a390b55e1941d14925 Mon Sep 17 00:00:00 2001 From: nilshah98 Date: Tue, 11 Jun 2019 14:46:15 +0530 Subject: rst files added for all components --- code/browser.rst | 4 ++++ code/browser/UserManual.rst | 6 ++++++ code/browser/Welcome.rst | 5 +++++ code/frontEnd.rst | 8 ++++++++ code/frontEnd/Application.rst | 5 +++++ code/frontEnd/DockArea.rst | 5 +++++ code/frontEnd/ProjectExplorer.rst | 5 +++++ code/frontEnd/Workspace.rst | 5 +++++ code/kicadtoNgspice.rst | 13 +++++++++++++ code/kicadtoNgspice/Analysis.rst | 5 +++++ code/kicadtoNgspice/Convert.rst | 5 +++++ code/kicadtoNgspice/DeviceModel.rst | 5 +++++ code/kicadtoNgspice/KicadtoNgspice.rst | 5 +++++ code/kicadtoNgspice/Model.rst | 5 +++++ code/kicadtoNgspice/Processing.rst | 5 +++++ code/kicadtoNgspice/Source.rst | 5 +++++ code/kicadtoNgspice/SubcircuitTab.rst | 6 ++++++ code/kicadtoNgspice/TrackWidget.rst | 5 +++++ code/modelEditor.rst | 3 +++ code/ngspiceSimulation.rst | 6 ++++++ code/ngspiceSimulation/NgspiceWidget.rst | 5 +++++ code/ngspiceSimulation/pythonPlotting.rst | 5 +++++ code/projectManagement.rst | 2 +- code/projectManagement/.Kicad.rst.swp | Bin 12288 -> 0 bytes code/subcircuit.rst | 5 +++++ code/subcircuit/Subcircuit.rst | 6 ++++++ code/subcircuit/convertSub.rst | 5 +++++ code/subcircuit/newSub.rst | 5 +++++ code/subcircuit/openSub.rst | 6 ++++++ 29 files changed, 149 insertions(+), 1 deletion(-) create mode 100644 code/browser/UserManual.rst create mode 100644 code/browser/Welcome.rst create mode 100644 code/frontEnd/Application.rst create mode 100644 code/frontEnd/DockArea.rst create mode 100644 code/frontEnd/ProjectExplorer.rst create mode 100644 code/frontEnd/Workspace.rst create mode 100644 code/kicadtoNgspice/Analysis.rst create mode 100644 code/kicadtoNgspice/Convert.rst create mode 100644 code/kicadtoNgspice/DeviceModel.rst create mode 100644 code/kicadtoNgspice/KicadtoNgspice.rst create mode 100644 code/kicadtoNgspice/Model.rst create mode 100644 code/kicadtoNgspice/Processing.rst create mode 100644 code/kicadtoNgspice/Source.rst create mode 100644 code/kicadtoNgspice/SubcircuitTab.rst create mode 100644 code/kicadtoNgspice/TrackWidget.rst create mode 100644 code/ngspiceSimulation/NgspiceWidget.rst create mode 100644 code/ngspiceSimulation/pythonPlotting.rst delete mode 100644 code/projectManagement/.Kicad.rst.swp create mode 100644 code/subcircuit/Subcircuit.rst create mode 100644 code/subcircuit/convertSub.rst create mode 100644 code/subcircuit/newSub.rst create mode 100644 code/subcircuit/openSub.rst (limited to 'code') 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 Binary files a/code/projectManagement/.Kicad.rst.swp and /dev/null 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: + -- cgit From 6e0e63e0df985a704e5245737c396b363e9860e8 Mon Sep 17 00:00:00 2001 From: nilshah98 Date: Sat, 15 Jun 2019 18:43:23 +0530 Subject: setup.py and conf.py configured for `Read The Docs` documentation --- code/frontEnd/Workspace.rst | 2 +- code/modelEditor/modelEditor.rst | 2 +- code/projectManagement.rst | 4 +++- 3 files changed, 5 insertions(+), 3 deletions(-) (limited to 'code') diff --git a/code/frontEnd/Workspace.rst b/code/frontEnd/Workspace.rst index 8f45816f..8722c745 100644 --- a/code/frontEnd/Workspace.rst +++ b/code/frontEnd/Workspace.rst @@ -2,4 +2,4 @@ Workspace Component =================== .. automodule:: frontEnd.Workspace - :pmembers: + :members: diff --git a/code/modelEditor/modelEditor.rst b/code/modelEditor/modelEditor.rst index 66f115e7..61aa5300 100644 --- a/code/modelEditor/modelEditor.rst +++ b/code/modelEditor/modelEditor.rst @@ -3,4 +3,4 @@ Model Editor Component .. automodule:: modelEditor.ModelEditor :members: - + \ No newline at end of file diff --git a/code/projectManagement.rst b/code/projectManagement.rst index ecf01006..1122fc91 100644 --- a/code/projectManagement.rst +++ b/code/projectManagement.rst @@ -1,5 +1,5 @@ Project Management Component -========================== +============================ .. toctree:: :maxdepth: 2 @@ -8,5 +8,7 @@ Project Management Component projectManagement/Kicad projectManagement/Validation projectManagement/Worker + projectManagement/openProject + projectManagement/newProject -- cgit