Stop tracking the built site; adopt the man/figures convention#96
Merged
Conversation
Untrack docs/ (the generated pkgdown site) and add it to .gitignore so the built site is no longer committed. Move the README figures from tools/ to man/figures/ (fig.path) so pkgdown serves them on the site home page, set the site url in _pkgdown.yml, and point the DESCRIPTION URL at the package site and repository.
The default fig.align = "center" stamps each figure display:block, so the paired comparison plots (default vs circle, lower vs upper triangle) stacked instead of sitting side by side despite out.width = "48%". Override fig.align = "default" on just those two chunks so the 48%-wide images flow inline; single-plot examples keep the centered layout.
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.
Adopts the standard tidyverse/ggpubr documentation setup:
docs/(the generated pkgdown site) and gitignore it, so the built site is no longer committed and can't go stale in git. It is rebuilt locally / deployed to the package site.tools/→man/figures/(viafig.path). pkgdown can only serve images fromman/figuresorvignettes, so the site home page (built from README.md) was showing broken images; now they resolve. This path also works on GitHub.urlin_pkgdown.ymland align the DESCRIPTIONURLwith the package site + repository, sopkgdown::check_pkgdown()passes (it now reports no problems).Docs/infra only — no code change.
R CMD check --as-cranclean (no warnings/errors);pkgdown::check_pkgdown()reports no problems and the site builds with the home-page images resolving.