"""Documentation Generation"""
from __future__ import unicode_literals
import webnotes
import inspect, importlib, os
from jinja2 import Template
from webnotes.modules import get_doc_path, get_module_path
@webnotes.whitelist()
def get_docs():
docs = {}
get_docs_for(docs, "webnotes")
docs["modules"] = get_modules()
docs["pages"] = get_pages()
return docs
def get_pages():
mydocs = {}
for repo in ("lib", "app"):
for path, folders, files in os.walk(os.path.join("..", repo)):
if os.path.basename(path)=="docs":
# docs folder
for fname in files:
if fname.endswith(".md"):
fpath = os.path.join("..", repo, "docs", fname)
with open(fpath, "r") as docfile:
mydocs[fname[:-3]] = docfile.read()
return mydocs
def get_docs_for(docs, name):
classname = ""
parts = name.split(".")
if not parts[-1] in docs:
docs[parts[-1]] = {}
mydocs = docs[parts[-1]]
try:
obj = importlib.import_module(name)
except ImportError:
# class
name, classname = ".".join(parts[:-1]), parts[-1]
module = importlib.import_module(name)
obj = getattr(module, classname)
mydocs["_intro"] = getattr(obj, "__doc__", "")
mydocs["_toc"] = getattr(obj, "_toc", "")
mydocs["_type"] = inspect.isclass(obj) and "class" or "module"
for name in dir(obj):
value = getattr(obj, name)
if (mydocs["_type"]=="class" and inspect.ismethod(value)) or \
(mydocs["_type"]=="module" and inspect.isfunction(value)):
mydocs[name] = {
"_type": "function",
"_args": inspect.getargspec(value)[0],
"_help": getattr(value, "__doc__", "")
}
if mydocs["_toc"]:
for name in mydocs["_toc"]:
get_docs_for(mydocs, name)
return mydocs
def get_modules():
# readme.md
# _toc [doctypes, pages, reports]
# in doctype
docs = {
"_label": "Modules"
}
modules = webnotes.conn.sql_list("select name from `tabModule Def` order by name limit 1")
docs["_toc"] = ["docs.dev.modules." + d for d in modules]
for m in modules:
prefix = "docs.dev.modules." + m
docs[m] = {
"_label": m,
"_toc": [
prefix + ".doctype",
prefix + ".page",
prefix + ".report"
],
"doctype": get_doctypes(m),
"page": {},
"report": {}
}
readme_path = os.path.join(get_module_path(m), "README.md")
if os.path.exists(readme_path):
with open(readme_path, "r") as readmefile:
docs[m]["_intro"] = readmefile.read()
return docs
def get_doctypes(m):
doctypes = webnotes.conn.sql_list("""select name from
tabDocType where module=%s order by name limit 1""", m)
docs = {
"_label": "DocTypes for " + m,
"_toc": ["docs.dev.modules." + m + ".doctype." + d for d in doctypes]
}
for d in doctypes:
try:
meta = webnotes.get_doctype(d)
mydocs = docs[d] = {
"_label": d,
"_type": "doctype"
}
readme_path = os.path.join(get_doc_path(m, "DocType", d), "README.md")
if os.path.exists(readme_path):
with open(readme_path, "r") as readmefile:
mydocs["_intro"] = readmefile.read()
for df in meta.get({"doctype": "DocField"}):
df = df.fields
df["_type"] = "docfield"
mydocs[df.fieldname] = df
except Exception, e:
pass
return docs
@webnotes.whitelist()
def write_doc_file(name, html, title):
if not os.path.exists("docs"):
os.mkdir("docs")
os.mkdir("docs/css")
os.mkdir("docs/css/fonts")
os.mkdir("docs/js")
os.system("cp ../lib/public/js/bootstrap.min.js docs/js")
os.system("cp ../lib/public/js/jquery.min.js docs/js")
os.system("cp ../lib/public/css/bootstrap.css docs/css")
os.system("cp ../lib/public/css/font-awesome.css docs/css")
os.system("cp ../lib/public/css/fonts/* docs/css/fonts")
with open(os.path.join("docs", name + ".html"), "w") as docfile:
html = Template(docs_template).render({
"title": title,
"content": html,
"description": title
})
docfile.write(html.encode("utf-8", errors="ignore"))
docs_template = """
{{ title }}
erpnext