1
0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00

Introduce DOCS_ROOT configuration parameter

This commit is contained in:
Jeremy Stretch
2020-03-06 09:35:58 -05:00
parent 7d236b607e
commit c50714ec42
4 changed files with 30 additions and 7 deletions

View File

@@ -4,6 +4,7 @@ import re
import yaml
from django import template
from django.conf import settings
from django.urls import NoReverseMatch, reverse
from django.utils.html import strip_tags
from django.utils.safestring import mark_safe
@@ -222,9 +223,18 @@ 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()
path = '{}/models/{}/{}.md'.format(
settings.DOCS_ROOT,
model._meta.app_label,
model._meta.model_name
)
try:
with open(path) as docfile:
content = docfile.read()
except FileNotFoundError:
return "Unable to load documentation, file not found: {}".format(path)
except IOError:
return "Unable to load documentation, error reading file: {}".format(path)
# Render Markdown with the admonition extension
content = markdown(content, extensions=['admonition', 'fenced_code'])