fix: pass explicit dest_dir to pkgdown to avoid docs/ conflict#75
Merged
Conversation
build_site_github_pages() checks docs/ by default even when _pkgdown.yml sets destination: _site. Passing dest_dir explicitly prevents the check_dest_is_pkgdown() error without touching the governance docs/ directory. Closes #74 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.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.
Summary
Passes
dest_dir = "_site"explicitly topkgdown::build_site_github_pages()so it no longer inspects the governancedocs/directory and errors withcheck_dest_is_pkgdown().Motivation
Closes #74 — the pkgdown CI job fails because
docs/contains non-pkgdown files (architecture, glossary, roadmap, etc.).Changes
.github/workflows/pkgdown.yml: addeddest_dir = "_site"argument (consistent withdestination: _sitealready in_pkgdown.yml)Testing
destination: _sitein_pkgdown.ymland the explicitdest_dirin the workflow are now consistent — pkgdown will output to_site/and the deploy step already reads from that folderNotes
One-line fix. No behavioral change to the built site — only prevents the pre-build directory check from erroring on
docs/.