Enable local partial templates that override global template #1897
Conversation
This file contains 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
Adds `src_path` argument to `find_templates()` and passes `pkg$src_path` to this argument wherever `find_templates()` is called
hadley
reviewed
Nov 10, 2021
R/templates.R
Outdated
| @@ -2,14 +2,16 @@ find_template <- function(type, | |||
| name, | |||
| ext = ".html", | |||
| templates_dir = NULL, | |||
| bs_version = 3) { | |||
| bs_version = 3, | |||
There was a problem hiding this comment.
I wonder if it's now the time to bite the bullet and pass pkg to this function?
There was a problem hiding this comment.
I agree, I'll add that change
existing arguments that require the `pkg` object are now calculated in `template_candidates()`
|
How about a new subsection at the end of https://pkgdown.r-lib.org/dev/articles/customise.html#additional-html-and-files — I think you could just briefly mention this as an option for experts. And can you please add a news bullet somewhere in https://github.com/r-lib/pkgdown/blob/HEAD/NEWS.md#customisation? |
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #1893 by adding a
src_pathargument tofind_templates()and passingpkg$src_pathto this argument whereverfind_templates()is called.Two follow up questions:
Would you like this feature documented anywhere specific? I looked around for a good place but didn't find a good fit — perhaps at the end of Customize - Template Packages?
At this point
find_templates()requirespkgfor 3 of its arguments. I could refactorfind_templates()to takepkgas an argument, likely the first argument in line with other functions in pkgdown. The only downside I see is that we'd end up calculatingtemplates_dira few more times than necessary if we calltemplates_dir(pkg)insidefind_templates(). I don't think that would have a noticeable impact, though.I'd be happy to add the refactoring to this PR if desired.