Version 6.x.x Source

Introduction


frappe.utils.autodoc ~~~~~~~~~~~~~~~~~~~~

Inspect elements of a given module and return its objects



frappe.utils.autodoc.automodel (doctype)

return doctype template


frappe.utils.autodoc.automodule (name)

Returns a list of attributes for given module string.

Attribute Format:

{
    "name": [__name__],
    "type": ["function" or "class"]
    "args": [inspect.getargspec(value) (for function)]
    "docs": [__doc__ as markdown]
}

Parameters:


frappe.utils.autodoc.get_class_info (class_obj, module_name)

No docs


frappe.utils.autodoc.get_function_info (value)

No docs


frappe.utils.autodoc.get_version (name)

No docs


frappe.utils.autodoc.parse (docs)

Parameters:

Parse docs text into markdown. Will parse directives like - **name** - etc


frappe.utils.autodoc.strip_leading_tabs (docs)

Strip leading tabs from doc text.