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

Update SDR guides, Getting Started Guide and fix Sphinx warnings for release #29

Merged
gillian merged 2 commits from docs/sdr-guides-update into main 2026-04-24 11:52:45 -04:00
Conversation 0 Commits 2 Files Changed 10 +568 -413
G
G gillian commented 2026-04-24 10:27:43 -04:00
Owner
Copy Link

Fix Sphinx build errors:

  • Add missing blank lines in rtlsdr.rst code-block directives
  • Rename duplicate label in examples/sdr/index.rst
  • Fix field list indentation in usrp.py and hackrf.py docstrings

Update SDR setup guides (all guides now cover both pip/venv and Radioconda):

  • rtlsdr: switch to rtl-sdr-blog fork (required for rtlsdr_set_dithering
    symbol), add pyrtlsdr==0.3.0 and setuptools==69.5.1 version pinning,
    preserve Radioconda blacklist and udev symlink paths alongside new steps
  • pluto: simplify primary path to apt install libiio, add Avahi network
    discovery note, preserve Radioconda udev symlink as alternative
  • hackrf: note out-of-box support, preserve Radioconda udev symlink
  • blade: note no extra Python packages needed, preserve Radioconda udev symlinks
  • usrp: add build-from-source path for pip/venv users with cmake flags,
    Python binding copy step, and version mismatch warning; keep conda install
    as primary option; preserve Radioconda udev symlink
  • thinkrf: add lib2to3 install step, Python <=3.12 restriction, and full
    Python 3 patching command to replace internal script reference

Update copyright year to 2026 in conf.py

Fix Sphinx build errors: - Add missing blank lines in rtlsdr.rst code-block directives - Rename duplicate label in examples/sdr/index.rst - Fix field list indentation in usrp.py and hackrf.py docstrings Update SDR setup guides (all guides now cover both pip/venv and Radioconda): - rtlsdr: switch to rtl-sdr-blog fork (required for rtlsdr_set_dithering symbol), add pyrtlsdr==0.3.0 and setuptools==69.5.1 version pinning, preserve Radioconda blacklist and udev symlink paths alongside new steps - pluto: simplify primary path to apt install libiio, add Avahi network discovery note, preserve Radioconda udev symlink as alternative - hackrf: note out-of-box support, preserve Radioconda udev symlink - blade: note no extra Python packages needed, preserve Radioconda udev symlinks - usrp: add build-from-source path for pip/venv users with cmake flags, Python binding copy step, and version mismatch warning; keep conda install as primary option; preserve Radioconda udev symlink - thinkrf: add lib2to3 install step, Python <=3.12 restriction, and full Python 3 patching command to replace internal script reference Update copyright year to 2026 in conf.py
gillian added 1 commit 2026-04-24 10:27:43 -04:00
M Update SDR guides and fix Sphinx warnings for release 
Fix Sphinx build errors:
- Add missing blank lines in rtlsdr.rst code-block directives
- Rename duplicate label in examples/sdr/index.rst
- Fix field list indentation in usrp.py and hackrf.py docstrings

Update SDR setup guides (all guides now cover both pip/venv and Radioconda):
- rtlsdr: switch to rtl-sdr-blog fork (required for rtlsdr_set_dithering
  symbol), add pyrtlsdr==0.3.0 and setuptools==69.5.1 version pinning,
  preserve Radioconda blacklist and udev symlink paths alongside new steps
- pluto: simplify primary path to apt install libiio, add Avahi network
  discovery note, preserve Radioconda udev symlink as alternative
- hackrf: note out-of-box support, preserve Radioconda udev symlink
- blade: note no extra Python packages needed, preserve Radioconda udev symlinks
- usrp: add build-from-source path for pip/venv users with cmake flags,
  Python binding copy step, and version mismatch warning; keep conda install
  as primary option; preserve Radioconda udev symlink
- thinkrf: add lib2to3 install step, Python <=3.12 restriction, and full
  Python 3 patching command to replace internal script reference

Update copyright year to 2026 in conf.py
All checks were successful
Build Sphinx Docs Set / Build Docs (pull_request) Successful in 6m4s
Details
Build Project / Build Project (3.10) (pull_request) Successful in 11m52s
Details
Build Project / Build Project (3.11) (pull_request) Successful in 11m50s
Details
Build Project / Build Project (3.12) (pull_request) Successful in 11m51s
Details
Test with tox / Test with tox (3.11) (pull_request) Successful in 12m10s
Details
Test with tox / Test with tox (3.12) (pull_request) Successful in 6m22s
Details
Test with tox / Test with tox (3.10) (pull_request) Successful in 12m28s
Details
a68a325cb4
G gillian requested review from madrigal 2026-04-24 10:27:59 -04:00
G gillian requested review from muq 2026-04-24 10:28:30 -04:00
G gillian removed review request for madrigal 2026-04-24 10:28:33 -04:00
M muq approved these changes 2026-04-24 10:29:47 -04:00
M muq left a comment
Member
Copy Link

Looks good

Looks good
gillian added 1 commit 2026-04-24 10:36:21 -04:00
G Merge branch 'main' into docs/sdr-guides-update
All checks were successful
Build Sphinx Docs Set / Build Docs (pull_request) Successful in 35s
Details
Build Project / Build Project (3.10) (pull_request) Successful in 5m49s
Details
Build Project / Build Project (3.11) (pull_request) Successful in 19m39s
Details
Build Project / Build Project (3.12) (pull_request) Successful in 19m21s
Details
Test with tox / Test with tox (3.11) (pull_request) Successful in 21m31s
Details
Test with tox / Test with tox (3.12) (pull_request) Successful in 17m24s
Details
Test with tox / Test with tox (3.10) (pull_request) Successful in 21m51s
Details
4df5455af4
G gillian merged commit 2baae2f63e into main 2026-04-24 11:52:45 -04:00
G gillian deleted branch docs/sdr-guides-update 2026-04-24 11:52:45 -04:00
Sign in to join this conversation.
Reviewers
No reviewers
Mmuq
Labels
Clear labels
  
CI/CD 🛠️

This issue relates to our automated testing, building, and publishing processes

  
WIP 🚧

Someone is currently worked on this issue

  
bug 🐞

There is a problem, error, or unexpected behaviour

  
code quality 🧹

This issues pertains to code quality improvements or tech debt reduction

  
data collection 🗃️

This issue involves machine learning data collection or filing

  
dependency 📦

This issue pertains to dependency changes or deprecation warnings

  
do not merge 🚫

This pull request is not to be merged

  
documentation 📝

Improvements or additions to documentation or tutorials

  
duplicate 🔄

This issue or pull request already exists

  
enhancement ✨

This issue is important and will require attention soon, but does not pose any immediate risks

  
good first issue 🌱

A good first issue for newcomers

  
help wanted 👋

Additional development support is required

  
inference 🧠

This issue involves designing or improving inference solutions

  
invalid 🛑

Something is wrong with this issue or it not does conform to project guidelines

  
machine learning 🚀

This issue pertains to and may require expertise in machine learning

  
priority
high🔥
This issue is critical and requires immediate attention to prevent further consequence or escalation

  
priority
low 🍃

  
priority
medium 🌟
This issue is important and will require attention soon, but does not pose any immediate risks

  
quantum ⚛️

This issue pertains to and may require expertise in quantum technology

  
question ❓

Additional information is required

  
radio 📡

This issue involves radio interface components and may requires access to radio hardware

  
sprintable 🏃‍♂️

This issue could be resolved in a single sprint

  
test 🧪

This issue pertains to our testing efforts

  
wont fix ❌

We've chosen not to address this issue

No Label
CI/CD 🛠️
WIP 🚧
bug 🐞
code quality 🧹
data collection 🗃️
dependency 📦
do not merge 🚫
documentation 📝
duplicate 🔄
enhancement ✨
good first issue 🌱
help wanted 👋
inference 🧠
invalid 🛑
machine learning 🚀
priority
high🔥
priority
low 🍃
priority
medium 🌟
quantum ⚛️
question ❓
radio 📡
sprintable 🏃‍♂️
test 🧪
wont fix ❌
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
2 Participants
G M
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: qoherent/ria-toolkit-oss#29
No description provided.
Delete Branch "docs/sdr-guides-update"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?