From 8126709c8dbcb0811a257978eb4e1fb8c403ec2e Mon Sep 17 00:00:00 2001 From: Oscar Gustafsson <oscar.gustafsson@liu.se> Date: Tue, 28 Feb 2023 10:56:01 +0000 Subject: [PATCH] Better documentation for research and gui_utils modules --- b_asic/gui_utils/__init__.py | 6 ++++++ b_asic/research/__init__.py | 12 ++++++++++++ docs_sphinx/gui_utils.rst | 8 ++++++-- docs_sphinx/research.rst | 4 ++++ 4 files changed, 28 insertions(+), 2 deletions(-) diff --git a/b_asic/gui_utils/__init__.py b/b_asic/gui_utils/__init__.py index e69de29b..9859b8cd 100644 --- a/b_asic/gui_utils/__init__.py +++ b/b_asic/gui_utils/__init__.py @@ -0,0 +1,6 @@ +""" +B-ASIC GUI utilities. + +This module contains GUI classes that have a general use and are not +strictly related to either the Block Diagram GUI or Scheduler GUI. +""" diff --git a/b_asic/research/__init__.py b/b_asic/research/__init__.py index e69de29b..5004affd 100644 --- a/b_asic/research/__init__.py +++ b/b_asic/research/__init__.py @@ -0,0 +1,12 @@ +""" +B-ASIC module for research purposes. + +This module contains functions that are used in different research +projects. They are typically not general enough to be part of the main +library, but are packaged here for convenience, reproducibility, and +that they may be useful for someone else as well. + +The following module is currently available: + +- :mod:`b_asic.research.interleaver`: generate matrix transposers and random interleavers. +""" diff --git a/docs_sphinx/gui_utils.rst b/docs_sphinx/gui_utils.rst index 50e0d0bc..f7bedf2d 100644 --- a/docs_sphinx/gui_utils.rst +++ b/docs_sphinx/gui_utils.rst @@ -1,5 +1,9 @@ -gui\_utils package -================== +GUI Utilities +============= + +.. automodule:: b_asic.gui_utils + :members: + :undoc-members: gui\_utils.about\_window module ------------------------------- diff --git a/docs_sphinx/research.rst b/docs_sphinx/research.rst index e64712df..a6ec0af8 100644 --- a/docs_sphinx/research.rst +++ b/docs_sphinx/research.rst @@ -1,6 +1,10 @@ Research functions ================== +.. automodule:: b_asic.research + :members: + :undoc-members: + research.interleaver module --------------------------- -- GitLab