Minor fixes to docs layout and coloring

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

View File

@ -3,8 +3,8 @@
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@300&display=swap"> <link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@300&display=swap">
<style> <style>
* { body {
color: #f0f0f0; color: #f0f0f0; /* your white-ish default */
font-family: 'Open Sans', sans-serif; font-family: 'Open Sans', sans-serif;
font-weight: 300; font-weight: 300;
} }
@ -104,67 +104,65 @@
color: #03A9F4; color: #03A9F4;
} }
#subpackages span.pre {
color: #03A9F4;
}
* h1, h2, h3, h4, h5, h6 { * h1, h2, h3, h4, h5, h6 {
color: #f0f0f0; color: #f0f0f0;
font-family: 'Open Sans', sans-serif; font-family: 'Open Sans', sans-serif;
font-weight: 300; font-weight: 300;
} }
code.docria_toolkit_oss.literal.notranslate { /* Default code blocks */
code.literal.notranslate {
border-radius: 4px; border-radius: 4px;
border: 1px solid rgba(255, 255, 255, .1); border: 1px solid rgba(255, 255, 255, 0.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;
background-color: #171717; background-color: #171717;
} padding: 3px 4px;
font-family: SFMono-Regular, Consolas, 'Liberation Mono', Menlo, Courier, monospace;
.rst-content code.literal { font-weight: 500;
font-size: 14px;
color: #AE81FF;
white-space: nowrap; white-space: nowrap;
} }
.wy-menu code.docria_toolkit_oss.literal.notranslate, .toctree-wrapper.compound code.docria_toolkit_oss.literal.notranslate { /* Sidebar menu code */
font-size: 11.96px; .wy-menu code.literal.notranslate,
.toctree-wrapper.compound code.literal.notranslate {
font-size: 12px;
text-decoration: none; text-decoration: none;
border: none; border: none;
background-color: inherit; 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; 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; color: #f0f0f0;
background-color: #1c1c1c; background-color: #1c1c1c;
border: none; border: none;
} }
.toctree-wrapper.compound code.docria_toolkit_oss.literal.notranslate span.pre { .toctree-wrapper.compound code.literal.notranslate span.pre {
color: #03A9F4; color: #03A9F4;
border: none; 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; background-color: #222222;
border: none; 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-feature-settings: normal;
font-variation-settings: normal; font-variation-settings: normal;
color: #fff; 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; font-size: 16px;
} }
@ -390,12 +388,8 @@
color: #fff; color: #fff;
} }
* span.pre { .highlight .mf {
color: #03A9F4; color: #AE81FF;
}
.wy-menu span.pre {
color: #f0f0f0;
} }
</style> </style>

View File

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

View File

@ -2,3 +2,11 @@ IO Package (ria_toolkit_oss.io)
=============================== ===============================
.. automodule:: ria_toolkit_oss.io .. automodule:: ria_toolkit_oss.io
Recording
---------
.. automodule:: ria_toolkit_oss.io.recording
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,17 +1,10 @@
Utils Package (ria_toolkit_oss.utils) Utils Package (ria_toolkit_oss.utils)
===================================== =====================================
Package Contents
----------------
.. automodule:: ria_toolkit_oss.utils .. automodule:: ria_toolkit_oss.utils
:members:
:undoc-members:
:show-inheritance:
Array Conversion
Array Conversion SubModule ----------------
--------------------------
.. automodule:: ria_toolkit_oss.utils.array_conversion .. automodule:: ria_toolkit_oss.utils.array_conversion
:members: :members:

View File

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

View File

@ -148,7 +148,9 @@ class RadioDataset(ABC):
"""Supplement the dataset with new examples by applying various transformations to the pre-existing examples """Supplement the dataset with new examples by applying various transformations to the pre-existing examples
in the dataset. 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 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 augmentation. In many cases, training on augmented data can enhance the generalization and robustness of

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 The IO package contains utilities for input and output operations, such as loading and saving recordings to and from
file. 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