137 lines
4.2 KiB
Python
137 lines
4.2 KiB
Python
"""Automatically setup docs for a project
|
|
|
|
Call from command line:
|
|
|
|
bench frappe --setup_docs app docs_app path
|
|
|
|
"""
|
|
|
|
import os, json, frappe
|
|
|
|
class setup_docs(object):
|
|
def __init__(self, app, docs_app, path):
|
|
"""Generate source templates for models reference and module API.
|
|
|
|
Must set globals `self.models_base_path`, `self.api_base_path` and `self.app_path`.
|
|
"""
|
|
self.app = app
|
|
self.app_path = frappe.get_app_path(app)
|
|
if path[0]=="/": path = path[1:]
|
|
path = frappe.get_app_path(docs_app, path)
|
|
self.models_base_path = os.path.join(path, "models")
|
|
self.api_base_path = os.path.join(path, "api")
|
|
|
|
for basepath, folders, files in os.walk(self.app_path):
|
|
if "doctype" not in basepath:
|
|
if "doctype" in folders:
|
|
module = os.path.basename(basepath)
|
|
|
|
module_folder = os.path.join(self.models_base_path, module)
|
|
|
|
self.make_folder(module_folder)
|
|
self.update_index_txt(module_folder)
|
|
|
|
if "doctype" in basepath:
|
|
parts = basepath.split("/")
|
|
#print parts
|
|
module, doctype = parts[-3], parts[-1]
|
|
|
|
if doctype not in ("doctype", "boilerplate"):
|
|
self.write_model_file(basepath, module, doctype)
|
|
|
|
elif self.is_py_module(basepath, folders, files):
|
|
self.write_modules(basepath, folders, files)
|
|
|
|
def is_py_module(self, basepath, folders, files):
|
|
return "__init__.py" in files \
|
|
and (not "/doctype" in basepath) \
|
|
and (not "/patches" in basepath) \
|
|
and (not "/change_log" in basepath) \
|
|
and (not "/report" in basepath) \
|
|
and (not "/page" in basepath) \
|
|
and (not "/templates" in basepath) \
|
|
and (not "/tests" in basepath) \
|
|
and (not "doctype" in folders)
|
|
|
|
def write_modules(self, basepath, folders, files):
|
|
module_folder = os.path.join(self.api_base_path, os.path.relpath(basepath, self.app_path))
|
|
self.make_folder(module_folder)
|
|
|
|
for f in files:
|
|
if f.endswith(".py"):
|
|
module_name = os.path.relpath(os.path.join(basepath, f),
|
|
self.app_path)[:-3].replace("/", ".").replace(".__init__", "")
|
|
|
|
module_doc_path = os.path.join(module_folder,
|
|
self.app + "." + module_name + ".html")
|
|
|
|
self.make_folder(basepath)
|
|
|
|
if not os.path.exists(module_doc_path):
|
|
print "Writing " + module_doc_path
|
|
with open(module_doc_path, "w") as f:
|
|
f.write("""<h1>%(name)s</h1>
|
|
|
|
<!-- title: %(name)s -->
|
|
{%%- from "templates/autodoc/macros.html" import automodule -%%}
|
|
|
|
{{ automodule("%(name)s") }}""" % {"name": self.app + "." + module_name})
|
|
|
|
self.update_index_txt(module_folder)
|
|
|
|
def make_folder(self, path):
|
|
if not os.path.exists(path):
|
|
os.makedirs(path)
|
|
|
|
index_txt_path = os.path.join(path, "index.txt")
|
|
if not os.path.exists(index_txt_path):
|
|
print "Writing " + index_txt_path
|
|
with open(index_txt_path, "w") as f:
|
|
f.write("")
|
|
|
|
index_md_path = os.path.join(path, "index.html")
|
|
if not os.path.exists(index_md_path):
|
|
name = os.path.basename(path)
|
|
if name==".":
|
|
name = self.app
|
|
print "Writing " + index_md_path
|
|
with open(index_md_path, "w") as f:
|
|
f.write("""<h1>{0}</h1>
|
|
<!-- title: {0} -->
|
|
{{index}}""".format(name))
|
|
|
|
def update_index_txt(self, path):
|
|
index_txt_path = os.path.join(path, "index.txt")
|
|
pages = filter(lambda d: (d.endswith(".html") and d!="index.html") \
|
|
or os.path.isdir(os.path.join(path, d)), os.listdir(path))
|
|
pages = [d.rsplit(".", 1)[0] for d in pages]
|
|
|
|
with open(index_txt_path, "r") as f:
|
|
index_parts = filter(None, f.read().splitlines())
|
|
|
|
if not set(pages).issubset(set(index_parts)):
|
|
print "Updating " + index_txt_path
|
|
with open(index_txt_path, "w") as f:
|
|
f.write("\n".join(pages))
|
|
|
|
def write_model_file(self, basepath, module, doctype):
|
|
model_path = os.path.join(self.models_base_path, module, doctype + ".html")
|
|
|
|
if not os.path.exists(model_path):
|
|
model_json_path = os.path.join(basepath, doctype + ".json")
|
|
if os.path.exists(model_json_path):
|
|
with open(model_json_path, "r") as j:
|
|
doctype_real_name = json.loads(j.read()).get("name")
|
|
|
|
print "Writing " + model_path
|
|
|
|
with open(model_path, "w") as f:
|
|
f.write("""<h1>%(doctype)s</h1>
|
|
|
|
<!-- title: %(doctype)s -->
|
|
{%% from "templates/autodoc/doctype.html" import render_doctype %%}
|
|
|
|
{{ render_doctype("%(doctype)s") }}
|
|
|
|
<!-- jinja --><!-- static -->
|
|
""" % {"doctype": doctype_real_name})
|