Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Autogenerate docs/funcs.md #65

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

ssssam
Copy link
Contributor

@ssssam ssssam commented Nov 3, 2019

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:

  • Update packages (to avoid hopefully merge conflicts in package-lock.json)
  • Add 'mustache' templating library
  • Rewrite scripts/docs.js to generate docs/funcs.md using a mustache template, and information added to hydra-synth.git in Add documentation to composable-glsl-functions.js hydra-synth#28.
  • Commit the new autogenerated docs/funcs.md

You 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.

@ssssam
Copy link
Contributor Author

ssssam commented Nov 6, 2019

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.
Base automatically changed from master to main February 28, 2021 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant