Skip to content

Docs for each version on gh-pages, without R - #75

Merged
jonathan-taylor merged 4 commits into
mainfrom
docs-versions
Oct 27, 2026
Merged

jonathan-taylor merged 4 commits into
mainfrom
docs-versions

Conversation

@jonathan-taylor

Copy link
Copy Markdown
Collaborator

Summary

The docs workflow builds each version into its own folder of the gh-pages branch, so old releases' docs stay online:

  • A release: gh workflow run build_docs.yml -f version=X.Y.Z builds tag vX.Y.Z's docs, with the labs that tag's submodule pins and ISLP==X.Y.Z from PyPI, into X.Y.Z/.
  • dev: with no version, the run builds the branch it runs on from source into dev/.
  • The landing version: -f landing=X.Y.Z sets it, and landing.txt keeps it for later runs. Without it, the landing is the latest release.
    • The site root redirects to it.
    • 404.html sends a path without a version (e.g. the README's /ISLP/labs.html, and links in the book) to that page in the landing version.
  • versions.html and versions.json list the folders.
  • R: no longer installed, and rpy2 is filtered out (no page or lab runs R).
  • Changelog: a bullet under Unreleased.

Caveat: an old release's docs are built with today's dependencies. For example, 0.5.2 ran with glmstar 0.7.0.

Status

  • Built so far from this branch:
    • 0.5.2/: passed, about 5 min;
    • 0.6.0/: running.
  • Queued: 0.5.1 (with landing=0.5.2), 0.5.0, 0.4.1, 0.4.0 and dev.
  • To publish: switch Settings → Pages → Source to the gh-pages branch. Until then the live site keeps the last deploy.
  • Order: this conflicts with Docs: build with uv, without conda or R #74 in build_docs.yml. Once that merges, I'll rebase this onto it so the versioned build uses uv too.

🤖 Generated with Claude Code

jonathan-taylor and others added 4 commits October 27, 2026 11:02
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…74

The merge took main's checkout and install, so a release's build used
main's docs and ISLP from source. Back: the tag's checkout, ISLP==X.Y.Z
from PyPI (with uv), rpy2 filtered from an old tag's requirements, and
the release builds deploy from any branch (dev/ only from main).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@jonathan-taylor
jonathan-taylor merged commit 46fb7df into main Oct 27, 2026
1 check passed
@jonathan-taylor
jonathan-taylor deleted the docs-versions branch October 27, 2026 18:27
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