qoherent/ria-toolkit-oss
13
6
Fork 0
Code Issues Pull Requests Workflows Packages Projects Releases 2 Wiki Activity

Minor fixes to docs layout and coloring

Browse Source
This commit is contained in:
Michael Luciuk 2025-09-04 14:04:33 -04:00
parent 131dc3f933
commit b4b8d27bfd
7 changed files with 45 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
docs/source/.templates/layout.html
View File

@ -3,10 +3,10 @@
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@300&display=swap">
<style>
* {
color: #f0f0f0;
font-family: 'Open Sans', sans-serif;
font-weight: 300;
body {
color: #f0f0f0; /* your white-ish default */
font-family: 'Open Sans', sans-serif;
font-weight: 300;
}
.wy-nav-content:not(:has(section)) {
@ -104,67 +104,65 @@
color: #03A9F4;
}
#subpackages span.pre {
color: #03A9F4;
}
* h1, h2, h3, h4, h5, h6 {
color: #f0f0f0;
font-family: 'Open Sans', sans-serif;
font-weight: 300;
}
code.docria_toolkit_oss.literal.notranslate {
/* Default code blocks */
code.literal.notranslate {
border-radius: 4px;
border: 1px solid rgba(255, 255, 255, .1);
background: #171717;
padding: 3px 4px;
}
code.docria_toolkit_oss.literal.notranslate span.pre:not(.wy-menu code.docria_toolkit_oss.literal.notranslate span.pre):not(.toctree-wrapper.compound code.docria_toolkit_oss.literal.notranslate span.pre) {
color: #AE81FF;
font-size: 14px;
font-weight: 530;
font-family: SFMono-Regular, Consolas, liberation mono, Menlo, Courier, monospace;
border: 1px solid rgba(255, 255, 255, 0.1);
background-color: #171717;
}
.rst-content code.literal {
padding: 3px 4px;
font-family: SFMono-Regular, Consolas, 'Liberation Mono', Menlo, Courier, monospace;
font-weight: 500;
font-size: 14px;
color: #AE81FF;
white-space: nowrap;
}
.wy-menu code.docria_toolkit_oss.literal.notranslate, .toctree-wrapper.compound code.docria_toolkit_oss.literal.notranslate {
font-size: 11.96px;
/* Sidebar menu code */
.wy-menu code.literal.notranslate,
.toctree-wrapper.compound code.literal.notranslate {
font-size: 12px;
text-decoration: none;
border: none;
background-color: inherit;
}
.wy-menu:hover code.docria_toolkit_oss.literal.notranslate span.pre {
/* Sidebar hover */
.wy-menu:hover code.literal.notranslate span.pre {
background-color: inherit;
}
.wy-menu code.docria_toolkit_oss.literal.notranslate span.pre {
/* Specific sidebar code spans */
.wy-menu code.literal.notranslate span.pre {
color: #f0f0f0;
background-color: #1c1c1c;
border: none;
}
.toctree-wrapper.compound code.docria_toolkit_oss.literal.notranslate span.pre {
.toctree-wrapper.compound code.literal.notranslate span.pre {
color: #03A9F4;
border: none;
}
code.xref.py.py-obj.docria_toolkit_oss.literal.notranslate span.pre, code.xref.py.py-class.docria_toolkit_oss.literal.notranslate span.pre, code.xref.py.py-func.docria_toolkit_oss.literal.notranslate span.pre {
/* Cross-reference code styling */
code.xref.py.py-obj.literal.notranslate span.pre,
code.xref.py.py-class.literal.notranslate span.pre,
code.xref.py.py-func.literal.notranslate span.pre {
background-color: #222222;
border: none;
font-family: ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,liberation mono,courier new,monospace;
font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, 'Liberation Mono', 'Courier New', monospace;
font-feature-settings: normal;
font-variation-settings: normal;
color: #fff;
}
code.xref.py.py-func.docria_toolkit_oss.literal.notranslate span.pre {
/* Function references */
code.xref.py.py-func.literal.notranslate span.pre {
font-size: 16px;
}
@ -390,12 +388,8 @@
color: #fff;
}
* span.pre {
color: #03A9F4;
}
.wy-menu span.pre {
color: #f0f0f0;
.highlight .mf {
color: #AE81FF;
}
</style>

12
docs/source/ria_toolkit_oss/datatypes/ria_toolkit_oss.datatypes.rst
View File

@ -6,18 +6,6 @@ Datatypes Package (ria_toolkit_oss.datatypes)
<br />
.. 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:

8
docs/source/ria_toolkit_oss/ria_toolkit_oss.io.rst
View File

@ -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:

11
docs/source/ria_toolkit_oss/ria_toolkit_oss.utils.rst
View File

@ -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:

4
docs/source/ria_toolkit_oss/ria_toolkit_oss.viz.rst
View File

@ -1,5 +1,5 @@
Viz (ria_toolkit_oss.view)
==========================================
Viz Package (ria_toolkit_oss.view)
==================================
.. automodule:: ria_toolkit_oss.viz

4
src/ria_toolkit_oss/datatypes/datasets/radio_dataset.py
View File

@ -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

11
src/ria_toolkit_oss/io/__init__.py
View File

@ -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