From b4b8d27bfd1a7c52af621e5f779d8fb36861e952 Mon Sep 17 00:00:00 2001 From: michael Date: Thu, 4 Sep 2025 14:04:33 -0400 Subject: [PATCH] Minor fixes to docs layout and coloring --- docs/source/.templates/layout.html | 66 +++++++++---------- .../datatypes/ria_toolkit_oss.datatypes.rst | 12 ---- .../ria_toolkit_oss/ria_toolkit_oss.io.rst | 8 +++ .../ria_toolkit_oss/ria_toolkit_oss.utils.rst | 11 +--- .../ria_toolkit_oss/ria_toolkit_oss.viz.rst | 4 +- .../datatypes/datasets/radio_dataset.py | 4 +- src/ria_toolkit_oss/io/__init__.py | 11 ---- 7 files changed, 45 insertions(+), 71 deletions(-) diff --git a/docs/source/.templates/layout.html b/docs/source/.templates/layout.html index 0d106db..ca04c01 100644 --- a/docs/source/.templates/layout.html +++ b/docs/source/.templates/layout.html @@ -3,10 +3,10 @@ diff --git a/docs/source/ria_toolkit_oss/datatypes/ria_toolkit_oss.datatypes.rst b/docs/source/ria_toolkit_oss/datatypes/ria_toolkit_oss.datatypes.rst index e5e72ba..77e1b4e 100644 --- a/docs/source/ria_toolkit_oss/datatypes/ria_toolkit_oss.datatypes.rst +++ b/docs/source/ria_toolkit_oss/datatypes/ria_toolkit_oss.datatypes.rst @@ -6,18 +6,6 @@ Datatypes Package (ria_toolkit_oss.datatypes)
.. automodule:: ria_toolkit_oss.datatypes - -Package Contents ----------------- - -.. automodule:: ria_toolkit_oss.datatypes.annotation - :members: - :undoc-members: - :show-inheritance: - -.. _rec-label: - -.. automodule:: ria_toolkit_oss.datatypes.recording :members: :undoc-members: :show-inheritance: diff --git a/docs/source/ria_toolkit_oss/ria_toolkit_oss.io.rst b/docs/source/ria_toolkit_oss/ria_toolkit_oss.io.rst index 0ffbb4a..6d97ebc 100644 --- a/docs/source/ria_toolkit_oss/ria_toolkit_oss.io.rst +++ b/docs/source/ria_toolkit_oss/ria_toolkit_oss.io.rst @@ -2,3 +2,11 @@ IO Package (ria_toolkit_oss.io) =============================== .. automodule:: ria_toolkit_oss.io + +Recording +--------- + +.. automodule:: ria_toolkit_oss.io.recording + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/ria_toolkit_oss/ria_toolkit_oss.utils.rst b/docs/source/ria_toolkit_oss/ria_toolkit_oss.utils.rst index 99df4bb..14f7f6b 100644 --- a/docs/source/ria_toolkit_oss/ria_toolkit_oss.utils.rst +++ b/docs/source/ria_toolkit_oss/ria_toolkit_oss.utils.rst @@ -1,17 +1,10 @@ Utils Package (ria_toolkit_oss.utils) ===================================== -Package Contents ----------------- - .. automodule:: ria_toolkit_oss.utils - :members: - :undoc-members: - :show-inheritance: - -Array Conversion SubModule --------------------------- +Array Conversion +---------------- .. automodule:: ria_toolkit_oss.utils.array_conversion :members: diff --git a/docs/source/ria_toolkit_oss/ria_toolkit_oss.viz.rst b/docs/source/ria_toolkit_oss/ria_toolkit_oss.viz.rst index d08476d..e261d7d 100644 --- a/docs/source/ria_toolkit_oss/ria_toolkit_oss.viz.rst +++ b/docs/source/ria_toolkit_oss/ria_toolkit_oss.viz.rst @@ -1,5 +1,5 @@ -Viz (ria_toolkit_oss.view) -========================================== +Viz Package (ria_toolkit_oss.view) +================================== .. automodule:: ria_toolkit_oss.viz diff --git a/src/ria_toolkit_oss/datatypes/datasets/radio_dataset.py b/src/ria_toolkit_oss/datatypes/datasets/radio_dataset.py index d0ba73e..062137d 100644 --- a/src/ria_toolkit_oss/datatypes/datasets/radio_dataset.py +++ b/src/ria_toolkit_oss/datatypes/datasets/radio_dataset.py @@ -148,7 +148,9 @@ class RadioDataset(ABC): """Supplement the dataset with new examples by applying various transformations to the pre-existing examples in the dataset. - .. todo:: This method is currently under construction, and may produce unexpected results. + .. todo:: + + This method is currently under construction, and may produce unexpected results. The process of supplementing a dataset to artificially increases the diversity of the examples is called augmentation. In many cases, training on augmented data can enhance the generalization and robustness of diff --git a/src/ria_toolkit_oss/io/__init__.py b/src/ria_toolkit_oss/io/__init__.py index cc433de..1a6e1a0 100644 --- a/src/ria_toolkit_oss/io/__init__.py +++ b/src/ria_toolkit_oss/io/__init__.py @@ -2,14 +2,3 @@ The IO package contains utilities for input and output operations, such as loading and saving recordings to and from file. """ - -__all__ = [ - # Recording: - "load_rec", - "to_sigmf", - "from_sigmf", - "to_npy", - "from_npy", -] - -from .recording import from_npy, from_sigmf, load_rec, to_npy, to_sigmf