WIP: snippet generator interface #13
Draft
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
JordonPhillips
force-pushed
the
snippets
branch
from
3d6c437
to
82a36c8
Compare
JordonPhillips
force-pushed
the
snippets
branch
from
82a36c8
to
2dd1d9d
Compare
JordonPhillips
force-pushed
the
snippets
branch
from
2dd1d9d
to
9678934
Compare
This adds and makes use of a snippet generator interface that lets other generators provide examples to be included in the docs. It's unfortunately more ugly than I'd like, notbably with config. Generators will essentially have to run much of their generator to be able to provide an accurate example, so we have to give a fake plugin context that they can use. The codegen director will need to be updated to make this more workable. This is just a proof of concept meant to show how it might work from the doc generator side.
JordonPhillips
force-pushed
the
snippets
branch
from
9678934
to
aabf28c
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 adds and makes use of a snippet generator interface that lets other generators provide examples to be included in the docs.
It's unfortunately more ugly than I'd like, notbably with config. Generators will essentially have to run much of their generator to be able to provide an accurate example, so we have to give a fake plugin context that they can use.
The codegen director will need to be updated to make this more workable.
This is just a proof of concept meant to show how it might work from the doc generator side.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.