Skip to content

ensure deps and Roxygen are up to date before running pkgdown#4036

Merged
infotroph merged 1 commit into
PecanProject:developfrom
infotroph:pkgdown-ensure-deps
Jun 25, 2026
Merged

ensure deps and Roxygen are up to date before running pkgdown#4036
infotroph merged 1 commit into
PecanProject:developfrom
infotroph:pkgdown-ensure-deps

Conversation

@infotroph

Copy link
Copy Markdown
Member
  • Updates prerequisites for make pkgdocs to ensure Roxygen docs are up to date before running pkgdown. Needed because Pkgdown works from existing Rd pages and does not check whether they're in sync with the source comments.
  • The above also works to ensure that all dependencies are up to date, fixing the current proximal cause of CI failure in Rothc: Soil file support + read options from settings file #3788
  • Removes each package's docs/ folder from the list of files considered when checking if document, test, check, or install need to run. Otherwise running pkgdown immediately marks everything as needing redocumentation, reinstallation, etc.
  • sets lazy = TRUE in the pkgdown::build_site() call, to avoid recompiling pages that haven't changed since the last pkgdown run.

known pkgdown issues not addressed here:

@infotroph infotroph requested a review from divine7022 June 24, 2026 23:57

@divine7022 divine7022 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! totally makes sense
droped one tiny inline, not a blocker

Comment thread Makefile
# Generates a list of regular files at any depth inside its argument,
# excluding those in any `docs` folder
files_in_dir = $(filter-out \
${1}/docs/%, \

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any reason for not using this ?
reads same to me though, since next char is / so there's no $1docs concat risk,
just wanna make sure i am not missing something on second expan

Suggested change
${1}/docs/%, \
$1/docs/%, \

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I know* $1 and ${1} will act identically here, I just chose the delimited one on principle -- my rule is that if I'm even starting to ask "is there concat risk here", I add braces rather than think about it.

*(but note I'm saying this without looking anything up; Make variable syntax does differ from shell variable syntax in various weird little ways)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's fair, they are identical here so no behaviour change either way

@infotroph infotroph added this pull request to the merge queue Jun 25, 2026
Merged via the queue into PecanProject:develop with commit 44cd5d7 Jun 25, 2026
19 of 25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants