Skip to content

Manage dev and docs dependencies with uv dependency groups - #585

Merged
cbrnr merged 2 commits into
MIT-LCP:mainfrom
cbrnr:dependency-management
Oct 28, 2026
Merged

cbrnr merged 2 commits into
MIT-LCP:mainfrom
cbrnr:dependency-management

Conversation

@cbrnr

@cbrnr cbrnr commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor
  • Move dev tools from [project.optional-dependencies] to [dependency-groups], so they are no longer published as a wfdb[dev] extra
  • Move the docs requirements into a docs group, remove docs/requirements.txt, and build the docs with uv in CI and on Read the Docs
  • Pin Ruff exactly (== 0.17.3), because new releases can change formatting and lint results (thanks @tompollard for the suggestion!)
  • Add a uv entry to Dependabot (monthly, 7-day cooldown, increase-if-necessary): exact pins and upper bounds get bumped, lower bounds are left alone. Group the GitHub Actions updates into one PR.
  • Update README.md and DEVELOPING.md to use uv

I have one question: sphinx-rtd-theme and readthedocs-sphinx-search are not used by docs/conf.py (which uses the classic theme). Should we remove them?

Move dev tools and docs requirements from optional dependencies and
docs/requirements.txt into [dependency-groups], pin Ruff exactly, build
the docs with uv in CI and on Read the Docs, and let Dependabot bump
exact pins and upper bounds.
@tompollard

Copy link
Copy Markdown
Member

I have one question: sphinx-rtd-theme and readthedocs-sphinx-search are not used by docs/conf.py (which uses the classic theme). Should we remove them?

Yes, let's remove!

@tompollard tompollard left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks, this looks good! Happy to remove the sphinx-rtd-theme and readthedocs-sphinx-search here or in a separate PR.

@cbrnr

cbrnr commented Oct 28, 2026

Copy link
Copy Markdown
Contributor Author

Done, I've removed them.

@tompollard

Copy link
Copy Markdown
Member

Thanks @cbrnr! do you have permissions to merge PRs? If so, I'll leave you to merge when ready. If not, I'll add you as a maintainer so you can do this in future.

@cbrnr

cbrnr commented Oct 28, 2026

Copy link
Copy Markdown
Contributor Author

I do and I'll merge once all tests ideally come back green (or fail due to PhysioNet access)!

@cbrnr

cbrnr commented Oct 28, 2026

Copy link
Copy Markdown
Contributor Author

Alright, first job already failed as expected, so I'll just go ahead and merge. I'll submit the next PR soon (conversion to plain pytest).

@cbrnr
cbrnr merged commit ed543a5 into MIT-LCP:main Oct 28, 2026
14 of 18 checks passed
@cbrnr
cbrnr deleted the dependency-management branch October 28, 2026 19:38
@tompollard

Copy link
Copy Markdown
Member

Alright, first job already failed as expected, so I'll just go ahead and merge. I'll submit the next PR soon (conversion to plain pytest).

It failed the instant I added the 🚀 to your comment, so think it might have been my fault.

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.

2 participants