Commit Graph

2 Commits

Author SHA1 Message Date
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
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