Skip to content

Build the docs on Read the Docs with uv - #97

Merged
sequoiap merged 1 commit into
masterfrom
docs/rtd-uv
Oct 5, 2026
Merged

sequoiap merged 1 commit into
masterfrom
docs/rtd-uv

Conversation

@sequoiap

@sequoiap sequoiap commented Oct 5, 2026

Copy link
Copy Markdown
Collaborator

Read the Docs now supports uv natively. .readthedocs.yaml now installs with method: uv, command: sync, using the docs dependency group. That installs PyroLab and the docs tools at the versions in uv.lock, the same environment make doc uses locally. So docs/requirements.txt, which repeated the docs group by hand, is deleted.

Other changes:

  • Build image: ubuntu-22.04 → ubuntu-24.04, matching Read the Docs' uv example. Python stays at 3.11.
  • README: the "Building the Docs" section said to pip install -r requirements.txt and make html in docs/, but there is no docs/Makefile. It now says make doc / make serve.

Notes:

  • uv sync also installs the default dev group (pytest, mypy and so on). That's harmless, just slightly slower.
  • Read the Docs runs uv sync without --locked, so a stale lock could be re-resolved during the build. CI already fails on a stale uv.lock, so that shouldn't reach master.

Verification

  • I simulated the Read the Docs build locally from a clean checkout: uv sync --python 3.11 --group docs into a fresh environment, then jupyter-book config sphinx docs/, then sphinx.
    • It succeeds, with no import failures and the same warnings as the old requirements.txt build.
  • The Read the Docs check on this PR is the real test. Pull-request builds were just turned on, so that check should run here.

🤖 Generated with Claude Code

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>
@sequoiap
sequoiap merged commit 7ae72f6 into master Oct 5, 2026
10 checks passed
@sequoiap sequoiap mentioned this pull request Oct 5, 2026
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.

1 participant