Docs/fix links uv setup#1435
Open
hsusul wants to merge 2 commits into
Open
Conversation
jlarson4
reviewed
Jun 23, 2026
jlarson4
left a comment
jlarson4
left a comment
Collaborator
There was a problem hiding this comment.
Two small phrasing notes, other than that looks good.
Thank you for fixing those links!
| ``` | ||
|
|
||
| Dependency groups are defined in `pyproject.toml` under `[dependency-groups]`. The project sets `default-groups = ["dev", "docs", "jupyter"]`, so `uv sync` installs all three out of the box — you do not need to pass `--group` flags for the standard contributor setup. | ||
| Dependency groups are defined in `pyproject.toml` under `[dependency-groups]`. The project sets `default-groups = ["dev", "docs", "jupyter", "multimodal"]`, so `uv sync` installs the standard contributor environment out of the box — you do not need to pass `--group` flags for the standard contributor setup. |
Collaborator
There was a problem hiding this comment.
Let's rephrase this slightly, using "standard contributor environment" duplicates the same statement twice within this sentence. Replace with:
The project sets default-groups = ["dev", "docs", "jupyter", "multimodal"], uv sync installs these groups out of the box — you do not need to pass --group flags for the standard contributor setup.
| hot-reloading docs (they change in real time as you edit docstrings). | ||
|
|
||
| For documentation generation to work, install with `uv sync --group docs`. | ||
| For documentation generation to work, the standard `uv sync` is enough because `docs` is a default group. For a docs-focused environment without other default groups, use `uv sync --no-default-groups --group docs`. |
Collaborator
There was a problem hiding this comment.
This sentence can be whole re-written, you don't need to preserve the "For documentation generation to work":
The standard uv sync includes documentation generation. For a docs-focused environment...
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This is a small docs cleanup PR I noticed while going through the contributor and tutorial docs.
It fixes a couple of stale notebook/demo links and updates the UV setup wording so it matches the current default dependency groups.
Fixes no issue.
Type of change
Screenshots
Not applicable, docs-only change.
Validation
uv run --no-default-groups --group docs build-docspassedgit diff --checkpasseduv run build-docswas attempted, but dependency resolution failed before Sphinx due toy-py==0.6.2metadata from the defaultjupytergroup