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.

Sign up for GitHub

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

Jump to bottom

Use jinja for protodoc #15351

Closed
phlax opened this issue Mar 7, 2021 · 3 comments
Closed

Use jinja for protodoc #15351

phlax opened this issue Mar 7, 2021 · 3 comments
Assignees
@phlax
Labels
area/docs help wanted Needs help!

Comments

@phlax
Copy link
Member

phlax commented Mar 7, 2021

description

the complexity of protodoc seems to have outgrown the python templating pattern used

this is resulting in a lot of \n and {indent} fu and making it increasingly difficult to work with

one possible solution to this problem is to use python only to create structured variables that a proper templating/markup lang like jinja can consume
@phlax phlax added enhancement Feature requests. Not bugs or questions. triage Issue requires triage labels Mar 7, 2021
@phlax
Copy link
Member Author

phlax commented Mar 7, 2021

cc @htuch

@phlax phlax mentioned this issue Mar 7, 2021
Merged
@dio dio assigned phlax Mar 7, 2021
@dio dio removed the triage Issue requires triage label Mar 7, 2021
@htuch
Copy link
Member

htuch commented Mar 8, 2021

@phlax seems totally reasonable.

@mattklein123 mattklein123 added area/docs help wanted Needs help! and removed enhancement Feature requests. Not bugs or questions. labels Mar 8, 2021
htuch pushed a commit that referenced this issue Mar 8, 2021
@phlax
protodoc: Use jinja for rendering proto docs (#15352)
51db799 
Partial fix for #15351

Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax
Copy link
Member Author

phlax commented Feb 7, 2022

protodoc uses jinja now

@phlax phlax closed this as completed Feb 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@phlax phlax

Labels
area/docs help wanted Needs help!
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@dio @phlax @mattklein123 @htuch