Commit Graph

10 Commits

Author SHA1 Message Date
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
8a66860d33 Moved all contents of to , refactored accordingly
All checks were successful
Build Sphinx Docs Set / Build Docs (pull_request) Successful in 15m51s
Build Project / Build Project (3.10) (pull_request) Successful in 16m14s
Build Project / Build Project (3.11) (pull_request) Successful in 17m9s
Build Project / Build Project (3.12) (pull_request) Successful in 2m29s
Test with tox / Test with tox (3.12) (pull_request) Successful in 21m28s
Test with tox / Test with tox (3.10) (pull_request) Successful in 22m50s
Test with tox / Test with tox (3.11) (pull_request) Successful in 23m18s
2026-04-21 14:38:06 -04:00
e506d26450 Replaces the getting_started.rst placeholder with a full CLI reference
Some checks failed
Build Sphinx Docs Set / Build Docs (pull_request) Successful in 19s
Test with tox / Test with tox (3.11) (pull_request) Failing after 17s
Test with tox / Test with tox (3.12) (pull_request) Failing after 16s
Test with tox / Test with tox (3.10) (pull_request) Failing after 33s
Build Project / Build Project (3.10) (pull_request) Successful in 1m5s
Build Project / Build Project (3.12) (pull_request) Successful in 1m4s
Build Project / Build Project (3.11) (pull_request) Successful in 1m6s
covering installation, commands, YAML config patterns, and a cheat sheet.
Adds custom CSS/JS for heading colours, warning admonition styling, code
block colours, and ria command highlighting. Fixes .gitignore to exclude
docs/_build/.
2026-04-20 13:10:31 -04:00
9cbb9716af - Updating README with list of supported SDR devices
All checks were successful
Build Sphinx Docs Set / Build Docs (pull_request) Successful in 12s
Test with tox / Test with tox (3.11) (pull_request) Successful in 31s
Test with tox / Test with tox (3.12) (pull_request) Successful in 30s
Test with tox / Test with tox (3.10) (pull_request) Successful in 40s
Build Project / Build Project (3.11) (pull_request) Successful in 47s
Build Project / Build Project (3.10) (pull_request) Successful in 49s
Build Project / Build Project (3.12) (pull_request) Successful in 47s
- Adding note to installation instructions (both in the README and project docs) that SDR drivers must be installed separately
2025-10-03 10:22:54 -04:00
537207ca91 Formatting updates to setup instructions in the SDR guides 2025-10-03 10:01:28 -04:00
86d988ee55 Minor typo fix: "Conda package for RIA Toolkit OSS ..." -> "Conda packages for RIA Toolkit OSS ..."
All checks were successful
Build Sphinx Docs Set / Build Docs (push) Successful in 15s
Test with tox / Test with tox (3.11) (push) Successful in 32s
Test with tox / Test with tox (3.12) (push) Successful in 29s
Build Project / Build Project (3.10) (push) Successful in 46s
Build Project / Build Project (3.11) (push) Successful in 46s
Test with tox / Test with tox (3.10) (push) Successful in 43s
Build Project / Build Project (3.12) (push) Successful in 47s
2025-09-10 16:02:03 -04:00
49857071d2 Uptading installation instructions in the project docs set
All checks were successful
Build Sphinx Docs Set / Build Docs (push) Successful in 13s
Test with tox / Test with tox (3.11) (push) Successful in 32s
Test with tox / Test with tox (3.12) (push) Successful in 32s
Test with tox / Test with tox (3.10) (push) Successful in 41s
Build Project / Build Project (3.11) (push) Successful in 47s
Build Project / Build Project (3.10) (push) Successful in 50s
Build Project / Build Project (3.12) (push) Successful in 49s
2025-09-10 15:15:10 -04:00
131dc3f933 Adding Sphinx docs set 2025-09-04 12:29:54 -04:00