Autogenerate docs/funcs.md #65
Open
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
ssssam
force-pushed
the
sam/pr-autogenerate-docs
branch
from
d9c1876
to
08ac429
Compare
|
I've rebased this after you merged my other PRs. And with hydra-synth/hydra-synth#28 merged, this is now ready too :) |
The funcs.md file had diverged quite a lot from what the script generated. The new script means we can again autogenerate funcs.md from the hydra-synth/src/composable-glsl-functions.js file.
The location for function documentation is now hydra-synth.git/src/composable-glsl-functions.js.
ssssam
force-pushed
the
sam/pr-autogenerate-docs
branch
from
08ac429
to
3040917
Compare
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.
This PR came out of the discussion in https://github.com/ojack/hydra/pull/62. Maybe I got ahead of myself submitting this already, but it seemed the most well defined task to start with
The main changes are:
docs/funcs.mdYou can see the diff from the old documentation by looking at the diff of this PR. I spent some time making sure there were no unnecessary changes, but I also wanted to keep script/docs.js as simple as I could, so there are still some changes to formatting and content. Hopefully I made the right tradeoffs.