Просмотр исходного кода

Introduce get_docs() template filter for models

Jeremy Stretch 6 лет назад
Родитель
Сommit
defe59d79e
1 измененных файлов с 14 добавлено и 0 удалено
  1. 14 0
      netbox/utilities/templatetags/helpers.py

+ 14 - 0
netbox/utilities/templatetags/helpers.py

@@ -216,6 +216,20 @@ def percentage(x, y):
     return round(x / y * 100)
 
 
+@register.filter()
+def get_docs(model):
+    """
+    Render and return documentation for the specified model.
+    """
+    path = '../docs/models/{}/{}.md'.format(model._meta.app_label, model._meta.model_name)
+    with open(path) as docfile:
+        content = docfile.read()
+
+    content = markdown(content, extensions=['mdx_gfm'])
+
+    return mark_safe(content)
+
+
 #
 # Tags
 #