FilesExpand file tree

 main

/

rstjinja.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

44 lines (32 loc) · 1.16 KB

 main

/

rstjinja.py

Copy path

Top

File metadata and controls

• Code
• Blame

44 lines (32 loc) · 1.16 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

# Derived from code on Eric Holscher's blog, found at:

# https://www.ericholscher.com/blog/2016/jul/25/integrating-jinja-rst-sphinx/

import re

def render_with_jinja(docname, source):

if re.search(r"^\s*.. jinja$", source[0], re.M):

return True

return False

def rstjinja(app, docname, source):

"""

Render our pages as a jinja template for fancy templating goodness.

"""

# Make sure we're outputting HTML

if app.builder.format not in ("html", "latex"):

return

# we only want specific files to run through this func

if not render_with_jinja(docname, source):

return

src = rendered = source[0]

print(f"rendering {docname} as jinja templates")

if app.builder.format == "html":

rendered = app.builder.templates.render_string(src, app.config.html_context)

else:

from sphinx.util.template import BaseRenderer

renderer = BaseRenderer()

rendered = renderer.render_string(src, app.config.html_context)

source[0] = rendered

def setup(app):

app.connect("source-read", rstjinja)

return {

"parallel_read_safe": True,

"parallel_write_safe": True,

}