152 lines
No EOL
3.9 KiB
HTML
152 lines
No EOL
3.9 KiB
HTML
<!-- title: frappe.utils.autodoc --><div class="dev-header">
|
|
|
|
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
|
|
Version 6.6.5</a>
|
|
|
|
|
|
<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/utils/autodoc.py"
|
|
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<h2>Introduction</h2><br><p>frappe.utils.autodoc
|
|
~~~~~~~~~~~~~~~~~~~~</p>
|
|
|
|
<p>Inspect elements of a given module and return its objects</p>
|
|
<br><br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.utils.autodoc.automodel" href="#frappe.utils.autodoc.automodel" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.utils.autodoc.<b>automodel</b>
|
|
<i class="text-muted">(doctype)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>return doctype template</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.utils.autodoc.automodule" href="#frappe.utils.autodoc.automodule" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.utils.autodoc.<b>automodule</b>
|
|
<i class="text-muted">(name)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Returns a list of attributes for given module string.</p>
|
|
|
|
<p>Attribute Format:</p>
|
|
|
|
<pre><code>{
|
|
"name": [__name__],
|
|
"type": ["function" or "class"]
|
|
"args": [inspect.getargspec(value) (for function)]
|
|
"docs": [__doc__ as markdown]
|
|
}
|
|
</code></pre>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
|
|
<ul>
|
|
<li><strong><code>name</code></strong> - Module name as string.</li>
|
|
</ul>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.utils.autodoc.get_class_info" href="#frappe.utils.autodoc.get_class_info" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.utils.autodoc.<b>get_class_info</b>
|
|
<i class="text-muted">(class_obj, module_name)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.utils.autodoc.get_function_info" href="#frappe.utils.autodoc.get_function_info" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.utils.autodoc.<b>get_function_info</b>
|
|
<i class="text-muted">(value)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.utils.autodoc.get_version" href="#frappe.utils.autodoc.get_version" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.utils.autodoc.<b>get_version</b>
|
|
<i class="text-muted">(name)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.utils.autodoc.parse" href="#frappe.utils.autodoc.parse" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.utils.autodoc.<b>parse</b>
|
|
<i class="text-muted">(docs)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><strong>Parameters:</strong></p>
|
|
|
|
<p>Parse <strong>docs</strong> text into markdown. Will parse directives like <code>- **</code>name<code>** -</code> etc</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.utils.autodoc.strip_leading_tabs" href="#frappe.utils.autodoc.strip_leading_tabs" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.utils.autodoc.<b>strip_leading_tabs</b>
|
|
<i class="text-muted">(docs)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Strip leading tabs from <strong>doc</strong> text.</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- autodoc --> |