Skip to content

Fix Read the Docs build by using uv for dependency management#367

Merged
Jordi Soucheiron (jsoucheiron) merged 3 commits intomasterfrom
fix/readthedocs-uv-dependency-groups
Mar 18, 2026
Merged

Fix Read the Docs build by using uv for dependency management#367
Jordi Soucheiron (jsoucheiron) merged 3 commits intomasterfrom
fix/readthedocs-uv-dependency-groups

Conversation

@jsoucheiron
Copy link
Copy Markdown
Member

Summary

  • Read the Docs build was failing because .readthedocs.yaml used extra_requirements: [dev, docs] which maps to [project.optional-dependencies], but the project migrated to [dependency-groups] (PEP 735) with uv in Migrate to uv native commands for package management #356
  • This caused mkdocs-material to not be installed (WARNING: cfripper 1.20.0 does not provide the extra 'docs'), breaking the docs build
  • Switch to build.commands with uv to properly install dependency groups via uv sync --group docs

Test plan

  • Trigger a Read the Docs build and verify it succeeds

🤖 Generated with Claude Code

The RTD build was failing because `extra_requirements: [dev, docs]` maps
to `[project.optional-dependencies]`, but the project migrated to
`[dependency-groups]` (PEP 735) with uv. This caused mkdocs-material
to not be installed, breaking the docs build.

Switch to `build.commands` with uv to properly resolve dependency groups.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@jsoucheiron Jordi Soucheiron (jsoucheiron) requested a review from a team as a code owner March 17, 2026 12:01
Copilot AI review requested due to automatic review settings March 17, 2026 12:01
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the Read the Docs configuration to restore docs builds after the project migrated from optional-dependencies extras to PEP 735 dependency-groups managed by uv.

Changes:

  • Remove RTD’s python.install pip + extra_requirements flow that no longer matches the project dependency model.
  • Switch RTD to custom build.commands that install the docs dependency group via uv and run mkdocs build.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +10 to +12
- asdf plugin add uv
- asdf install uv latest
- asdf global uv latest
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@jsoucheiron Jordi Soucheiron (jsoucheiron) merged commit 425925d into master Mar 18, 2026
14 checks passed
@jsoucheiron Jordi Soucheiron (jsoucheiron) deleted the fix/readthedocs-uv-dependency-groups branch March 18, 2026 07:43
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.

4 participants