Fix/docs render r libs#28
Merged
Merged
Conversation
docs/ isn't the repo root, so when Quarto spawns R to execute chunks in generated reference pages (e.g. reference/hello.qmd's roxygen @examples), it doesn't source the root .Rprofile's rv activation — rmarkdown (installed only into rv/library by rv sync) is invisible, failing with "there is no package called 'rmarkdown'" (seen in the first generate-docs.yml run after merging the docs unification). Export R_LIBS_USER pointing at rv's library (via `rv info --library`) before invoking `quarto render docs/`, in both justfile and CI. Assisted-by: Claude Sonnet 5 <noreply@anthropic.com>
novica
force-pushed
the
fix/docs-render-r-libs
branch
from
9d8e466 to
4332820
Compare
Matches the R version actually installed/tested against on this machine. Updates the pin in rproject.toml (regenerated rv.lock via rv sync), both GitHub Actions r-version inputs, and the devcontainer base image tag. Verified end-to-end locally now that rv's library matches the running R version: just lint/format/test all pass, and just docs-build renders the full site including hello.qmd's roxygen @examples chunks via knitr — confirming the R_LIBS_USER fix from the previous commit works for real, not just by inspection. Assisted-by: Claude Sonnet 5 <noreply@anthropic.com>
1. docs/index.qmd transcluded README's badges block (CI/release/tool
shields) onto the docs site — meaningless off GitHub. Wrap it in
README.md with <!-- badges: start/end --> markers and have
docs-build strip that block into a generated, gitignored
docs/_readme.md, which docs/index.qmd includes instead of README
directly.
2. The sidebar's Home entry rendered as the bare filename ("index.html")
while Architecture/API Reference showed real labels — the plain
`index.qmd` list entry had no explicit text, unlike navbar's
already-labeled Home link. Give it `text: Home` too.
Verified locally: rendered docs/html/index.html has zero
shields.io/badge.svg references, and the sidebar shows "Home" in nav,
sidebar, and breadcrumb.
Assisted-by: Claude Sonnet 5 <noreply@anthropic.com>
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
1 participant
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.
No description provided.