protodoc: Use jinja2 for rendering proto docs#15352
Merged
htuch merged 1 commit intoenvoyproxy:mainfrom Mar 8, 2021
Merged
Conversation
Signed-off-by: Ryan Northey <ryan@synca.io>
Member
Author
|
/retest |
|
Retrying Azure Pipelines: |
Member
Author
|
this PR only adds jinja and moves the current explicit templates i think we could go quite a bit further, but i think this is a good start |
Contributor
|
/lgtm deps |
Contributor
|
Looks good and @htuch should take a quick look |
htuch
reviewed
Mar 8, 2021
| indent = " " * indent | ||
| formatted_list = "\n".join(f"{indent}- :ref:`{ext} <{prefix}_{ext}>`" for ext in items) | ||
| return f"{formatted_list}\n{indent}\n" | ||
| return EXTENSION_TEMPLATE.render(extension=extension, |
Member
There was a problem hiding this comment.
There are probably a ton of other cleanup possibilities in this file. Would you prefer to leave them as TODOs?
Member
Author
There was a problem hiding this comment.
yep - for now i think yes - im happy to follow up tho
Member
Author
There was a problem hiding this comment.
i updated the PR to "partial fix for.," so we keep the sphinx ticket open once this lands
This file contains hidden or 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
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.
Commit Message: protodoc: Use jinja2 for rendering proto docs
Additional Description:
Risk Level:
Testing:
Docs Changes:
Release Notes:
Platform Specific Features:
[Optional Runtime guard:]
[Optional Fixes #Issue] Partial fix for #15351
[Optional Deprecated:]
[Optional API Considerations:]