Use YUIDoc theme helpers for local development. #1124
Merged
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.
It seems like 4de4a31 removed a bunch of duplicate files that are on p5.js-website, which makes the project nice and DRY, but this had the downside of making the generated yuidocs in
/docs/reference/
less useful, as the CSS is broken and example sketches don't render.There's a few potential fixes to this that I can think of:
grunt yui
that downloads the required p5.js-website assets to the directories where the yuidoc theme expects them to be.P5_SITE_ROOT
environment variable is set to..
.This implements option (3), though I'm not sure how much I like it. For instance:
On the plus side, though, the docs now link directly to the fresh p5 libraries that were just built by grunt, which makes the docs and examples easier to test.
All that said, I'm fine with this PR being rejected if one of the alternatives is a better fit.