-
-
Notifications
You must be signed in to change notification settings - Fork 102
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
feature: Jinja handler #661
Comments
I'm writing comments to the Python handler templates so this might be a good time to think about how to format them for easy retrieval and use. What kind of information should be retrievable from Jinja templates?
|
Hmm, available context (variables, functions, filters, tests, tags) cannot be fully inferred from static analysis only. But I don't see how we could use dynamic analysis, unless we profile the tool and its code rendering templates (I don't think that's feasible, or that it makes much sense anyway). For a complete list of what's available, template writers might need to document that in the template itself. |
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
I'll mark both our comments as off-topic (this issue is really about documenting Jinja templates, not Markdown/HTML (pre-)processing), I hope you won't mind 🙂 Feel free to open a dedicated discussion instead 🙂 |
Ah yep, understood. 👍🏼 |
Is your feature request related to a problem? Please describe.
No standard way to document Jinja templates?
Describe the solution you'd like
I just realized it would be nice to have a handler for documenting and auto-generating docs for Jinja templates.
It would parse the templates and extract information from Jinja comments for macros, filters, tests and context.
Describe alternatives you've considered
Manually written Markdown docs.
Additional context
Would be super useful for handlers themselves!
The text was updated successfully, but these errors were encountered: