Fix minor documentation issues

b_asic/gui_utils/plot_window.py

@@ -23,15 +23,29 @@ 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,
     ):
+        """
+        [summary]
+
+        """
         super().__init__(parent=parent)
         self.setWindowFlags(
             Qt.WindowTitleHint
@@ -199,8 +213,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)

docs_sphinx/codegen/index.rst

 .. _codegen:
 
-B-ASIC Code Generation
-**********************
+Code generation
+***************
 
 Code generation using the B-ASIC toolbox.
 

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:

docs_sphinx/index.rst

@@ -29,6 +29,6 @@ Table of Contents
    GUI
    scheduler_gui
    gui_utils
+   codegen/index
    examples/index
    research
-   codegen/index

examples/README.rst

 .. _examples:
 
-===============
-B-ASIC Examples
-===============
+========
+Examples
+========
 
 These are examples of how B-ASIC can be used.