From 821b417f08c0712e784f9f6b87b7ade214c73f28 Mon Sep 17 00:00:00 2001
From: Oscar Gustafsson <oscar.gustafsson@gmail.com>
Date: Tue, 14 Mar 2023 14:05:01 +0100
Subject: [PATCH] Fix minor documentation issues
---
b_asic/gui_utils/plot_window.py | 17 +++++++++++++----
docs_sphinx/codegen/index.rst | 4 ++--
docs_sphinx/codegen/vhdl.rst | 9 +++++++++
docs_sphinx/index.rst | 2 +-
examples/README.rst | 6 +++---
5 files changed, 28 insertions(+), 10 deletions(-)
diff --git a/b_asic/gui_utils/plot_window.py b/b_asic/gui_utils/plot_window.py
index d33033ee..c92c8b5a 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 683a1ff4..98eca629 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 e44e04fd..4dc935e6 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 f2f1e1ed..e5b6fed6 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 a4d5fdd6..0892c641 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.
--
GitLab