Skip to content

Update sigmf schema to v1.2.5 #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 16, 2025
Merged

Update sigmf schema to v1.2.5 #108

merged 1 commit into from
May 16, 2025

Conversation

777arc
Copy link
Member

@777arc 777arc commented May 16, 2025

haven't tested anything on the python side yet. @daniestevez this is for you =)

Copy link
Contributor

@daniestevez daniestevez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for addressing this so quickly! I've just tested our internal application with sigmf-python from this PR branch and it works correctly.

@777arc 777arc merged commit 0370403 into main May 16, 2025
8 checks passed
@Teque5
Copy link
Collaborator

Teque5 commented May 16, 2025

You guys were so fast you forgot to update __specification__ in __init__.py.

@777arc
Copy link
Member Author

777arc commented May 16, 2025

Ah my bad, is there a way we can have that read from the schema file somehow?

@777arc 777arc deleted the update-sigmf-schema-v1.2.5 branch May 16, 2025 23:33
@777arc
Copy link
Member Author

777arc commented May 16, 2025

Or at a minimum we could have a little github action that makes sure they always match 😄

@Teque5
Copy link
Collaborator

Teque5 commented May 16, 2025

Ah my bad, is there a way we can have that read from the schema file somehow?

If we do this we will also need to do that in docs/source/conf.py because it also reads the specification dynamically.

@daniestevez
Copy link
Contributor

If the Sphinx docs are built with sigmf-python installed, then we can pull this information directly from the Python package. Example: https://github.com/maia-sdr/pm-remez/blob/main/sphinx/source/conf.py#L16 (this is a Python package implemented in Rust, but for it doesn't make any difference for this). Probably the sigmf-python is already available when Read The Docs builds the docs. I've checked this pm-remez package to see if I configured anything in .readthedocs.yaml to make this happen, but I don't see anything special.

@daniestevez
Copy link
Contributor

I've given this a shot in #110, but someone with read the docs admin access should check that the docs from that PR branch can be built successfully.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants