diff --git a/b_asic/gui_utils/plot_window.py b/b_asic/gui_utils/plot_window.py index d33033eed7e650679d7574923eae121075364cce..c92c8b5af89c5b6e75e42696d41030a3b45158be 100644 --- a/b_asic/gui_utils/plot_window.py +++ b/b_asic/gui_utils/plot_window.py @@ -23,12 +23,22 @@ from qtpy.QtWidgets import ( # QFrame,; QScrollArea,; QLineEdit,; QSizePolicy,; class PlotWindow(QDialog): - """Dialog for plotting the result of a simulation.""" + """ + Dialog for plotting the result of a simulation. + + Parameters + ---------- + sim_result : dict + Simulation results of the form obtained from :attr:`~b_asic.simulation.Simulation.results`. + sfg_name : str, optional + The name of the SFG. + parent : optional + The parent window. + """ def __init__( self, sim_result: Dict[str, List[complex]], - logger=print, sfg_name: Optional[str] = None, parent=None, ): @@ -199,8 +209,7 @@ def start_simulation_dialog( sim_results : dict Simulation results of the form obtained from :attr:`~b_asic.simulation.Simulation.results`. sfg_name : str, optional - DESCRIPTION. The default is None. - + The name of the SFG. """ app = QApplication(sys.argv) win = PlotWindow(sim_result=sim_results, sfg_name=sfg_name) diff --git a/docs_sphinx/codegen/index.rst b/docs_sphinx/codegen/index.rst index 683a1ff44282c9efe9cf86a97e627b834244ad8e..98eca629bddcf084f8b3a3ec3e0759fbd5e12d43 100644 --- a/docs_sphinx/codegen/index.rst +++ b/docs_sphinx/codegen/index.rst @@ -1,7 +1,7 @@ .. _codegen: -B-ASIC Code Generation -********************** +Code generation +*************** Code generation using the B-ASIC toolbox. diff --git a/docs_sphinx/codegen/vhdl.rst b/docs_sphinx/codegen/vhdl.rst index e44e04fd7d2a41a363a46560c8ada231e229f443..4dc935e6a90b7892f00055e834ca365c861096ee 100644 --- a/docs_sphinx/codegen/vhdl.rst +++ b/docs_sphinx/codegen/vhdl.rst @@ -2,14 +2,23 @@ ``b_asic.codegen.vhdl`` *********************** +``common`` module +----------------- + .. automodule:: b_asic.codegen.vhdl.common :members: :undoc-members: +``entity`` module +----------------- + .. automodule:: b_asic.codegen.vhdl.entity :members: :undoc-members: +``architecture`` module +----------------------- + .. automodule:: b_asic.codegen.vhdl.architecture :members: :undoc-members: diff --git a/docs_sphinx/index.rst b/docs_sphinx/index.rst index f2f1e1edf816557d9f22b6dd9b93572953d45419..e5b6fed662497457c38a19a984362c30ac461d6a 100644 --- a/docs_sphinx/index.rst +++ b/docs_sphinx/index.rst @@ -29,6 +29,6 @@ Table of Contents GUI scheduler_gui gui_utils + codegen/index examples/index research - codegen/index diff --git a/examples/README.rst b/examples/README.rst index a4d5fdd6ad596bfbe941cce0d6e21fc0f522cd50..0892c641aa520831c18de50d50875ff10b38faaf 100644 --- a/examples/README.rst +++ b/examples/README.rst @@ -1,7 +1,7 @@ .. _examples: -=============== -B-ASIC Examples -=============== +======== +Examples +======== These are examples of how B-ASIC can be used.