Repository navigation
Build the docs on Read the Docs with uv - #97
Merged
Merged
Conversation
Read the Docs supports uv natively: `method: uv` with `command: sync` installs PyroLab and the "docs" dependency group from uv.lock, the same environment `make doc` uses. docs/requirements.txt duplicated that group by hand, so it is gone. The build image moves to ubuntu-24.04, as in Read the Docs' uv example. The README's docs instructions pointed at the deleted file and a docs/Makefile that no longer exists; they now point at `make doc`. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Merged
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
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.
Read the Docs now supports uv natively.
.readthedocs.yamlnow installs withmethod: uv,command: sync, using thedocsdependency group. That installs PyroLab and the docs tools at the versions inuv.lock, the same environmentmake docuses locally. Sodocs/requirements.txt, which repeated thedocsgroup by hand, is deleted.Other changes:
pip install -r requirements.txtandmake htmlindocs/, but there is nodocs/Makefile. It now saysmake doc/make serve.Notes:
uv syncalso installs the defaultdevgroup (pytest, mypy and so on). That's harmless, just slightly slower.uv syncwithout--locked, so a stale lock could be re-resolved during the build. CI already fails on a staleuv.lock, so that shouldn't reach master.Verification
uv sync --python 3.11 --group docsinto a fresh environment, thenjupyter-book config sphinx docs/, then sphinx.requirements.txtbuild.🤖 Generated with Claude Code