diff options
-rw-r--r-- | conf.py | 2 | ||||
-rw-r--r-- | images/dev_docs.png | bin | 0 -> 152831 bytes | |||
-rw-r--r-- | index.rst | 6 | ||||
-rw-r--r-- | src/frontEnd/Application.py | 19 |
4 files changed, 26 insertions, 1 deletions
@@ -21,7 +21,7 @@ autodoc_mock_imports = ["PyQt5", "pathmagic", "matplotlib", "numpy"] # -- Project information ----------------------------------------------------- project = u'eSim' -copyright = u'2022, FOSSEE' +copyright = u'2025, FOSSEE' author = u'FOSSEE, IIT Bombay' # The short X.Y version diff --git a/images/dev_docs.png b/images/dev_docs.png Binary files differnew file mode 100644 index 00000000..25459717 --- /dev/null +++ b/images/dev_docs.png @@ -6,6 +6,12 @@ Welcome to eSim's documentation! ================================ +**eSim** is a free/libre and open-source EDA tool for circuit design, simulation, analysis, and PCB design. It is an integrated tool built using free/libre and open-source software such as KiCad, Ngspice, GHDL, OpenModelica, Verilator, Makerchip, and SkyWater SKY130 PDK. + +.. image:: ./images/logo.png + :width: 100px + :target: https://esim.readthedocs.io/en/latest/index.html + .. image:: ./images/ki-ng.png :width: 100px :target: https://esim.readthedocs.io/en/latest/code/kicadtoNgspice.html diff --git a/src/frontEnd/Application.py b/src/frontEnd/Application.py index ea286651..01280a99 100644 --- a/src/frontEnd/Application.py +++ b/src/frontEnd/Application.py @@ -21,6 +21,7 @@ import os import sys import traceback +import webbrowser if os.name == 'nt': from frontEnd import pathmagic # noqa:F401 @@ -132,12 +133,21 @@ class Application(QtWidgets.QMainWindow): self.helpfile.setShortcut('Ctrl+H') self.helpfile.triggered.connect(self.help_project) + # added devDocs logo and called functions + self.devdocs = QtWidgets.QAction( + QtGui.QIcon(init_path + 'images/dev_docs.png'), + '<b>Dev Docs</b>', self + ) + self.devdocs.setShortcut('Ctrl+D') + self.devdocs.triggered.connect(self.dev_docs) + self.topToolbar = self.addToolBar('Top Tool Bar') self.topToolbar.addAction(self.newproj) self.topToolbar.addAction(self.openproj) self.topToolbar.addAction(self.closeproj) self.topToolbar.addAction(self.wrkspce) self.topToolbar.addAction(self.helpfile) + self.topToolbar.addAction(self.devdocs) # ## This part is meant for SoC Generation which is currently ## # ## under development and will be will be required in future. ## @@ -415,6 +425,15 @@ class Application(QtWidgets.QMainWindow): print("Current Project is : ", self.obj_appconfig.current_project) self.obj_Mainview.obj_dockarea.usermanual() + def dev_docs(self): + """ + This function guides the user to readthedocs website for the developer docs + """ + print("Function : DevDocs") + self.obj_appconfig.print_info('DevDocs is called') + print("Current Project is : ", self.obj_appconfig.current_project) + webbrowser.open("https://esim.readthedocs.io/en/latest/index.html") + @QtCore.pyqtSlot(QtCore.QProcess.ExitStatus, int) def plotSimulationData(self, exitCode, exitStatus): """Enables interaction for new simulation and |