docs: improve getting_started and installation readability #30

Open
gillian wants to merge 6 commits from docs/sdr-guides-update into main

6 Commits

Author SHA1 Message Date
4ce42fa71a Formatting, updated lock file
All checks were successful
Build Sphinx Docs Set / Build Docs (pull_request) Successful in 34s
Build Project / Build Project (3.10) (pull_request) Successful in 1m42s
Build Project / Build Project (3.11) (pull_request) Successful in 1m41s
Build Project / Build Project (3.12) (pull_request) Successful in 1m46s
Test with tox / Test with tox (3.11) (pull_request) Successful in 2m47s
Test with tox / Test with tox (3.12) (pull_request) Successful in 2m32s
Test with tox / Test with tox (3.10) (pull_request) Successful in 3m1s
2026-04-29 09:55:29 -04:00
e5a3d327e5 refactor: unify signal viewer styling and update docs screenshots
Some checks failed
Test with tox / Test with tox (3.11) (pull_request) Successful in 3m37s
Test with tox / Test with tox (3.12) (pull_request) Successful in 3m44s
Build Project / Build Project (3.10) (pull_request) Successful in 5m55s
Build Project / Build Project (3.11) (pull_request) Successful in 5m35s
Build Project / Build Project (3.12) (pull_request) Successful in 6m27s
Build Sphinx Docs Set / Build Docs (pull_request) Successful in 6m22s
Test with tox / Test with tox (3.10) (pull_request) Failing after 5m33s
- Align view_simple and view_full on background colour (#161616), title
  size (25pt), subtitle size (15pt), base font/tick/label sizes, grid
  style (alpha=0.2), and legend fontsize (10pt)
- Spectrogram placed above IQ plot in view_simple; subplot renamed from
  "Time Series" to "IQ Sample Plot"
- Frequency and spectrogram Y-axes formatted in MHz across both viewers
- Added xlabel/ylabel, subtle grids, and IQ legend to view_full subplots
- Fixed spectrogram right-side clipping in view_simple by syncing xlim
  from specgram output rather than total signal duration
- Updated getting_started.rst to reference both simple and full viewer
  screenshots; replaced doc images with latest renders
2026-04-28 14:08:44 -04:00
4c94f6ae94 Changed datasets to data to match utils 2026-04-28 12:49:43 -04:00
F fordg1
9a304faa00 docs: enhance getting started guide with example output and image reference
Some checks failed
Build Sphinx Docs Set / Build Docs (pull_request) Successful in 22s
Build Project / Build Project (3.10) (pull_request) Failing after 3m19s
Test with tox / Test with tox (3.11) (pull_request) Failing after 6m16s
Test with tox / Test with tox (3.10) (pull_request) Failing after 11m32s
Build Project / Build Project (3.11) (pull_request) Successful in 12m4s
Build Project / Build Project (3.12) (pull_request) Successful in 12m2s
Test with tox / Test with tox (3.12) (pull_request) Successful in 12m26s
2026-04-28 11:27:47 -04:00
a4cd158b2a Merge branch 'main' into docs/sdr-guides-update
All checks were successful
Build Sphinx Docs Set / Build Docs (pull_request) Successful in 6m36s
Build Project / Build Project (3.10) (pull_request) Successful in 3m50s
Build Project / Build Project (3.12) (pull_request) Successful in 3m38s
Build Project / Build Project (3.11) (pull_request) Successful in 4m0s
Test with tox / Test with tox (3.10) (pull_request) Successful in 5m16s
Test with tox / Test with tox (3.11) (pull_request) Successful in 5m33s
Test with tox / Test with tox (3.12) (pull_request) Successful in 5m24s
2026-04-24 14:36:53 -04:00
2c1fba75da docs: improve getting_started and installation readability
All checks were successful
Build Sphinx Docs Set / Build Docs (pull_request) Successful in 35s
Test with tox / Test with tox (3.11) (pull_request) Successful in 14m53s
Build Project / Build Project (3.12) (pull_request) Successful in 21m54s
Test with tox / Test with tox (3.10) (pull_request) Successful in 22m0s
Build Project / Build Project (3.11) (pull_request) Successful in 22m7s
Build Project / Build Project (3.10) (pull_request) Successful in 22m16s
Test with tox / Test with tox (3.12) (pull_request) Successful in 22m42s
- Consolidate installation steps into installation.rst (pip upgrade,
  ria --help verification, entrypoints note, editable install note,
  SDR driver table); replace getting_started §1 body with a link
- Reformat command and subcommand lists as tables with purpose
  descriptions and internal ref links for navigation
- Remove redundant §6 tips and §9 cheat sheet; trim duplicate
  descriptions in generate subcommand sections
- Fix inline code comments to sit beside the command they describe
- Add custom CSS for light body text, white headings, and table
  header colour to suit the dark background theme
2026-04-24 14:34:11 -04:00