#
# Jasy - Web Tooling Framework
# Copyright 2010-2012 Zynga Inc.
# Copyright 2013-2014 Sebastian Werner
#
import os
from jasy import UserError
import jasy.script.api.Data as Data
import jasy.core.Text as Text
import jasy.item.Abstract as AbstractItem
[docs]class DocItem(AbstractItem.AbstractItem):
kind = "jasy.Doc"
[docs] def generateId(self, relpath, package):
"""Generates the fileId of this item as being used by other modules."""
if package:
fileId = "%s/" % package
else:
fileId = ""
return (fileId + os.path.dirname(relpath)).replace("/", ".")
[docs] def getApi(self):
field = "api[%s]" % self.id
apidata = self.project.getCache().read(field, self.getModificationTime())
if not Text.supportsMarkdown:
raise UserError("Missing Markdown feature to convert package docs into HTML.")
if apidata is None:
apidata = Data.ApiData(self.id)
apidata.main["type"] = "Package"
apidata.main["doc"] = Text.highlightCodeBlocks(Text.markdownToHtml(self.getText()))
self.project.getCache().store(field, apidata, self.getModificationTime())
return apidata