More jinja functionality #786

Activity

1. LecrisUT

   added

   enhancementNew feature or requestNew feature or request

   on Jun 29, 2023
2. welcome commented on Jun 29, 2023

   

   welcomebot

   on Jun 29, 2023

   More actions

   Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗
   
   If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
   
   If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
   
   Welcome to the EBP community! 🎉
3. chrisjsewell commented on Jun 30, 2023

   

   chrisjsewell

   on Jun 30, 2023

   Member

   More actions

   I've tried simply parsing the files as jinja templates

   Heya, to note, myst-parser does not use jinja to actually parse the file, but only for expression evaluation.

   Parsing is done with a plugin to the Markdown parser, e.g.

   from markdown_it import MarkdownIt
   from markdown_it.tree import SyntaxTreeNode
   from mdit_py_plugins.substitution import substitution_plugin
   
   md = MarkdownIt().use(substitution_plugin)
   tree = SyntaxTreeNode(md.parse(
       "An {{ inline_expr }}\n\n"
       "{{ block_expr }}"
   ))
   print(tree.pretty())

   gives

   <root>
     <paragraph>
       <inline>
         <text>
         <substitution_inline text='inline_expr'>
     <substitution_block text='block_expr'>

   expressions are then evaluated in a post-processing step
4. LecrisUT commented on Jun 30, 2023

   

   LecrisUT

   on Jun 30, 2023

   Last edited by LecrisUT

   Author

   More actions

   Ok, it seems that the error I encountered was not on that side, and indeed I am able to hack in the jinja rendered with:

   def jinja_render(app: Sphinx, docname: str, source: list[str]) -> None:
       """
       Render pages as jinja templates
   
       :param app: Sphinx app
       :param docname: Name of the doc file
       :param source: Single element list with the source as first element
       """
       if app.builder.format != 'html':
           # Only parsing html for now
           return
       file = Path(app.env.doc2path(docname, base=False))
       if ".j2" not in file.suffixes:
           # If the file is not explicitly a jinja template do not parse it
           return
       src = source[0]
       rendered = app.builder.templates.render_string(src, app.config.html_context)
       source[0] = rendered
   
   
   def setup(app: Sphinx):
       app.connect("source-read", jinja_render)

   Only issue there is I can't extract the filename so that id doesn't try to render non-jinja file. If you have a clue, that would be wonderful
5. chrisjsewell commented on Jun 30, 2023

   

   chrisjsewell

   on Jun 30, 2023

   Member

   More actions

   You might want to have a look at https://pypi.org/project/sphinx-jinja/
6. LecrisUT commented on Jun 30, 2023

   

   LecrisUT

   on Jun 30, 2023

   Author

   More actions

   I did check that one out, and it uses directives. I want this one to be for the whole file. I've used this one for inspiration. Do you know how to extract the filename in general from app object?
7. chrisjsewell commented on Jun 30, 2023

   

   chrisjsewell

   on Jun 30, 2023

   Member

   More actions

   app.env.doc2path
8. LecrisUT commented on Jun 30, 2023

   

   LecrisUT

   on Jun 30, 2023

   Author

   More actions

   Thanks a bunch! I'll update the comment above with a short implementation. Not sure how to share it more generally though