Add render groups support #54
Merged
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
sjkaliski
approved these changes
May 21, 2019
Rolodex can now serialize and write docs to multiple targets for a single Phoenix router. This is helpful for cases where you want more than one documentation source for a single API (e.g. public and private API docs). To accomplish this goal, we're introducing the concept of "render groups". A render group is a combination of: (optional) filters, a processor, a writer, and writer options. Together, they encapsulate Rolodex's render logic: serialization and writing. You can specify as many render groups as you'd like in your Rolodex config module to generate as many documentation forms of your API!
bceskavich
force-pushed
the
bc-render-groups
branch
from
9481a6c to
514cbff
Compare
Merged
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.
Rolodex can now serialize and write docs to multiple targets for a
single Phoenix router. This is helpful for cases where you want
more than one documentation source for a single API (e.g. public and
private API docs).
To accomplish this goal, we're introducing the concept of "render groups".
A render group is a combination of: (optional) filters, a processor, a
writer, and writer options. Together, they encapsulate Rolodex's render
logic: serialization and writing. You can specify as many render groups as
you'd like in your Rolodex config module to generate as many documentation
forms of your API!