-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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
protodoc: Use jinja2 for rendering proto docs #15352
Conversation
Signed-off-by: Ryan Northey <ryan@synca.io>
/retest |
Retrying Azure Pipelines: |
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 |
/lgtm deps |
Looks good and @htuch should take a quick look |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, much cleaner!
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, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are probably a ton of other cleanup possibilities in this file. Would you prefer to leave them as TODOs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yep - for now i think yes - im happy to follow up tho
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i updated the PR to "partial fix for.," so we keep the sphinx ticket open once this lands
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm deps
LGTM, thanks!
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:]