diff --git a/b_asic/scheduler_gui/graphics_graph_event.py b/b_asic/scheduler_gui/graphics_graph_event.py index 2cd0f8acf8a2337677d7b9fbaa76fe9acfc960c6..346f6e88bf74d0b93b30612785e847fc7b2875f3 100644 --- a/b_asic/scheduler_gui/graphics_graph_event.py +++ b/b_asic/scheduler_gui/graphics_graph_event.py @@ -8,8 +8,8 @@ Contains the scheduler-gui GraphicsGraphEvent class containing event filters and from typing import List, Optional, overload # QGraphics and QPainter imports -from qtpy.QtCore import QEvent, QObject, QPointF, Qt, Signal -from qtpy.QtGui import QCursor, QFocusEvent +from qtpy.QtCore import QEvent, QObject, QPointF, Signal +from qtpy.QtGui import QFocusEvent from qtpy.QtWidgets import ( QGraphicsItem, QGraphicsSceneContextMenuEvent, @@ -30,7 +30,7 @@ class GraphicsGraphEvent: # PyQt5 """Event filter and handlers for GraphicsGraphItem""" class Signals(QObject): # PyQt5 - """A class respresenting signals.""" + """A class representing signals.""" component_selected = Signal(str) schedule_time_changed = Signal() diff --git a/b_asic/scheduler_gui/logger.py b/b_asic/scheduler_gui/logger.py index f6372f436e005f19d27f619fa5aca2424c747b5a..ee5ffa49821b3bc59dadab31f7f75bd3b453d30a 100644 --- a/b_asic/scheduler_gui/logger.py +++ b/b_asic/scheduler_gui/logger.py @@ -3,7 +3,7 @@ """B-ASIC Scheduler-gui Logger Module. Contains a logger that logs to the console and a file using levels. It is based -on the `logging` module and has predefined levels of logging. +on the :mod:`logging` module and has predefined levels of logging. Usage: ------ @@ -12,14 +12,31 @@ Usage: >>> log = logger.getLogger() >>> log.info('This is a log post with level INFO') -| Function call | Level | Numeric value | -|----------------|-----------|---------------| -| debug(str) | DEBUG | 10 | -| info(str) | INFO | 20 | -| warning(str) | WARNING | 30 | -| error(str) | ERROR | 40 | -| critical(str) | CRITICAL | 50 | -| exception(str) | ERROR | 40 | +.. list-table:: + :widths: 50 25 25 + :header-rows: 1 + + * - Function call + - Level + - Numeric value + * - debug(str) + - DEBUG + - 10 + * - info(str) + - INFO + - 20 + * - warning(str) + - WARNING + - 30 + * - error(str) + - ERROR + - 40 + * - critical(str) + - CRITICAL + - 50 + * - exception(str) + - ERROR + - 40 The last `exception(str)` is used to capture exceptions output, that normally won't be captured. diff --git a/docs_sphinx/GUI.rst b/docs_sphinx/GUI.rst new file mode 100644 index 0000000000000000000000000000000000000000..a8a9bee06257382b3e67d2eff1724b03b3e54d55 --- /dev/null +++ b/docs_sphinx/GUI.rst @@ -0,0 +1,101 @@ +Block Diagram GUI +================= + +Module contents +--------------- + +.. automodule:: b_asic.GUI + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +GUI.about\_window module +------------------------ + +.. automodule:: b_asic.GUI.about_window + :members: + :undoc-members: + :show-inheritance: + +GUI.arrow module +---------------- + +.. automodule:: b_asic.GUI.arrow + :members: + :undoc-members: + :show-inheritance: + +GUI.drag\_button module +----------------------- + +.. automodule:: b_asic.GUI.drag_button + :members: + :undoc-members: + :show-inheritance: + +GUI.gui\_interface module +------------------------- + +.. automodule:: b_asic.GUI.gui_interface + :members: + :undoc-members: + :show-inheritance: + +GUI.main\_window module +----------------------- + +.. automodule:: b_asic.GUI.main_window + :members: + :undoc-members: + :show-inheritance: + +GUI.port\_button module +----------------------- + +.. automodule:: b_asic.GUI.port_button + :members: + :undoc-members: + :show-inheritance: + +GUI.properties\_window module +----------------------------- + +.. automodule:: b_asic.GUI.properties_window + :members: + :undoc-members: + :show-inheritance: + +GUI.select\_sfg\_window module +------------------------------ + +.. automodule:: b_asic.GUI.select_sfg_window + :members: + :undoc-members: + :show-inheritance: + +GUI.show\_pc\_window module +--------------------------- + +.. automodule:: b_asic.GUI.show_pc_window + :members: + :undoc-members: + :show-inheritance: + +GUI.simulate\_sfg\_window module +-------------------------------- + +.. automodule:: b_asic.GUI.simulate_sfg_window + :members: + :undoc-members: + :show-inheritance: + +GUI.utils module +---------------- + +.. automodule:: b_asic.GUI.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs_sphinx/api/index.rst b/docs_sphinx/api/index.rst index 6d4e5707fb5e46d1381c064522eb8c7470f29629..9fa924758cff84fd65cfd2c5d2770e16eba9c594 100644 --- a/docs_sphinx/api/index.rst +++ b/docs_sphinx/api/index.rst @@ -9,6 +9,7 @@ API graph_component.rst operation.rst port.rst + process.rst schedule.rst signal.rst signal_flow_graph.rst diff --git a/docs_sphinx/index.rst b/docs_sphinx/index.rst index fd2eff3d9dcc96c27c0ab9d82a9ed467772c5c03..cf71767ad0196f7b969bacb71a4d7052462393b3 100644 --- a/docs_sphinx/index.rst +++ b/docs_sphinx/index.rst @@ -26,3 +26,5 @@ Table of Contents self api/index + GUI + scheduler_gui diff --git a/docs_sphinx/scheduler_gui.rst b/docs_sphinx/scheduler_gui.rst new file mode 100644 index 0000000000000000000000000000000000000000..ca5c2cfbe2308dac00cd2bbf44308efb0b482db4 --- /dev/null +++ b/docs_sphinx/scheduler_gui.rst @@ -0,0 +1,94 @@ +Scheduler GUI +============= + +Module contents +--------------- + +.. automodule:: b_asic.scheduler_gui + :members: + :undoc-members: + :show-inheritance: + + +Submodules +---------- + +scheduler\_gui.compile module +----------------------------- + +.. automodule:: b_asic.scheduler_gui.compile + :members: + :undoc-members: + :show-inheritance: + +scheduler\_gui.graphics\_axes\_item module +------------------------------------------ + +.. automodule:: b_asic.scheduler_gui.graphics_axes_item + :members: + :undoc-members: + :show-inheritance: + +scheduler\_gui.graphics\_component\_item module +----------------------------------------------- + +.. automodule:: b_asic.scheduler_gui.graphics_component_item + :members: + :undoc-members: + :show-inheritance: + +scheduler\_gui.graphics\_graph\_event module +-------------------------------------------- + +.. automodule:: b_asic.scheduler_gui.graphics_graph_event + :members: + :undoc-members: + :show-inheritance: + +scheduler\_gui.graphics\_graph\_item module +------------------------------------------- + +.. automodule:: b_asic.scheduler_gui.graphics_graph_item + :members: + :undoc-members: + :show-inheritance: + +scheduler\_gui.graphics\_signal module +-------------------------------------- + +.. automodule:: b_asic.scheduler_gui.graphics_signal + :members: + :undoc-members: + :show-inheritance: + +scheduler\_gui.graphics\_timeline\_item module +---------------------------------------------- + +.. automodule:: b_asic.scheduler_gui.graphics_timeline_item + :members: + :undoc-members: + :show-inheritance: + +scheduler\_gui.logger module +---------------------------- + +.. automodule:: b_asic.scheduler_gui.logger + :members: + :undoc-members: + :show-inheritance: + +scheduler\_gui.main\_window module +---------------------------------- + +.. automodule:: b_asic.scheduler_gui.main_window + :members: + :undoc-members: + :show-inheritance: + +scheduler\_gui.ui\_main\_window module +-------------------------------------- + +.. automodule:: b_asic.scheduler_gui.ui_main_window + :members: + :undoc-members: + :show-inheritance: