Skip to content

GitLab

Commit 3a73cbab authored by Anand Doshi's avatar Anand Doshi
Browse files

[docs]

parent 0134ac78
Hide whitespace changes
Inline Side-by-side
Showing
with 257 additions and 166 deletions
+257 -166
frappe/docs/current/api/core/frappe.core.notifications.html
View file @ 3a73cbab
......@@ -77,6 +77,22 @@
<p class="docs-attr-name">
<a name="frappe.core.notifications.get_unseen_likes" href="#frappe.core.notifications.get_unseen_likes" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.core.notifications.<b>get_unseen_likes</b>
<i class="text-muted">()</i>
</p>
<div class="docs-attr-desc"><p>Returns count of unseen likes</p>
</div>
<br>
<!-- autodoc -->
\ No newline at end of file
frappe/docs/current/api/desk/frappe.desk.like.html 0 → 100644
View file @ 3a73cbab
<!-- title: frappe.desk.like --><div class="dev-header">
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>
<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/desk/like.py"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
</div>
<p class="docs-attr-name">
<a name="frappe.desk.like._toggle_like" href="#frappe.desk.like._toggle_like" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.desk.like.<b>_toggle_like</b>
<i class="text-muted">(doctype, name, add, user=None)</i>
</p>
<div class="docs-attr-desc"><p>Same as toggle_like but hides param <code>user</code> from API</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.desk.like.add_comment" href="#frappe.desk.like.add_comment" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.desk.like.<b>add_comment</b>
<i class="text-muted">(doctype, 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.desk.like.remove_like" href="#frappe.desk.like.remove_like" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.desk.like.<b>remove_like</b>
<i class="text-muted">(doctype, name)</i>
</p>
<div class="docs-attr-desc"><p>Remove previous Like</p>
</div>
<br>
<p><span class="label label-info">Public API</span>
<br><code>/api/method/frappe.desk.like.toggle_like</code>
</p>
<p class="docs-attr-name">
<a name="frappe.desk.like.toggle_like" href="#frappe.desk.like.toggle_like" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.desk.like.<b>toggle_like</b>
<i class="text-muted">(doctype, name, add=False)</i>
</p>
<div class="docs-attr-desc"><p>Adds / removes the current user in the <code>__liked_by</code> property of the given document.
If column does not exist, will add it in the database.</p>
<p>The <code>_liked_by</code> property is always set from this function and is ignored if set via
Document API</p>
<p><strong>Parameters:</strong></p>
<ul>
<li><strong><code>doctype</code></strong> - DocType of the document to like</li>
<li><strong><code>name</code></strong> - Name of the document to like</li>
<li><strong><code>add</code></strong> - <code>Yes</code> if like is to be added. If not <code>Yes</code> the like will be removed.</li>
</ul>
</div>
<br>
<!-- autodoc -->
\ No newline at end of file
frappe/docs/current/api/desk/frappe.desk.notifications.html
View file @ 3a73cbab
......@@ -131,6 +131,22 @@
<p class="docs-attr-name">
<a name="frappe.desk.notifications.get_notifications_for" href="#frappe.desk.notifications.get_notifications_for" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.desk.notifications.<b>get_notifications_for</b>
<i class="text-muted">(notification_type, config, notification_count)</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.desk.notifications.get_notifications_for_doctypes" href="#frappe.desk.notifications.get_notifications_for_doctypes" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
......@@ -159,6 +175,22 @@
<p class="docs-attr-name">
<a name="frappe.desk.notifications.get_notifications_for_other" href="#frappe.desk.notifications.get_notifications_for_other" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.desk.notifications.<b>get_notifications_for_other</b>
<i class="text-muted">(config, notification_count)</i>
</p>
<div class="docs-attr-desc"><p>Notifications for other items</p>
</div>
<br>
<!-- autodoc -->
\ No newline at end of file
frappe/docs/current/api/desk/index.txt
View file @ 3a73cbab
frappe.desk.calendar
frappe.desk.desk_page
frappe.desk
frappe.desk.like
frappe.desk.moduleview
frappe.desk.notifications
frappe.desk.query_builder
......@@ -8,5 +9,4 @@ frappe.desk.query_report
frappe.desk.report_dump
frappe.desk.reportview
frappe.desk.search
frappe.desk.star
frappe.desk.tags
\ No newline at end of file
frappe/docs/current/api/frappe.sessions.html
View file @ 3a73cbab
......@@ -284,7 +284,7 @@
<a name="frappe.sessions.clear_sessions" href="#frappe.sessions.clear_sessions" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.sessions.<b>clear_sessions</b>
<i class="text-muted">(user=None, keep_current=False)</i>
<i class="text-muted">(user=None, keep_current=False, device=None)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
......
frappe/docs/current/api/model/frappe.model.db_query.html
View file @ 3a73cbab
......@@ -40,6 +40,20 @@
<p class="docs-attr-name">
<a name="add_comment_count" href="#add_comment_count" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>add_comment_count</b>
<i class="text-muted">(self, result)</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="add_limit" href="#add_limit" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
......@@ -156,7 +170,7 @@
<a name="execute" href="#execute" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>execute</b>
<i class="text-muted">(self, query=None, fields=None, filters=None, or_filters=None, docstatus=None, group_by=None, order_by=None, limit_start=False, limit_page_length=None, as_list=False, with_childnames=False, debug=False, ignore_permissions=False, user=None)</i>
<i class="text-muted">(self, query=None, fields=None, filters=None, or_filters=None, docstatus=None, group_by=None, order_by=None, limit_start=False, limit_page_length=None, as_list=False, with_childnames=False, debug=False, ignore_permissions=False, user=None, with_comment_count=False)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
......
frappe/docs/current/api/model/frappe.model.document.html
View file @ 3a73cbab
......@@ -110,7 +110,7 @@ all values (including child documents) from the database.</p>
<a name="add_comment" href="#add_comment" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>add_comment</b>
<i class="text-muted">(self, comment_type, text=None, comment_by=None)</i>
<i class="text-muted">(self, comment_type, text=None, comment_by=None, reference_doctype=None, reference_name=None)</i>
</p>
<div class="docs-attr-desc"><p>Add a comment to this document.</p>
......@@ -281,9 +281,9 @@ timestamps don't match.</p>
<p class="docs-attr-name">
<a name="get_permlevel_access" href="#get_permlevel_access" class="text-muted small">
<a name="get_liked_by" href="#get_liked_by" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_permlevel_access</b>
<b>get_liked_by</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
......@@ -295,12 +295,12 @@ timestamps don't match.</p>
<p class="docs-attr-name">
<a name="get_signature" href="#get_signature" class="text-muted small">
<a name="get_permlevel_access" href="#get_permlevel_access" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_signature</b>
<b>get_permlevel_access</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Returns signature (hash) for private URL.</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
......@@ -309,12 +309,12 @@ timestamps don't match.</p>
<p class="docs-attr-name">
<a name="get_starred_by" href="#get_starred_by" class="text-muted small">
<a name="get_signature" href="#get_signature" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_starred_by</b>
<b>get_signature</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
<div class="docs-attr-desc"><p>Returns signature (hash) for private URL.</p>
</div>
<br>
......
frappe/docs/current/api/utils/frappe.utils.bench_helper.html
View file @ 3a73cbab
......@@ -21,7 +21,7 @@
<a name="frappe.utils.bench_helper.app_group" href="#frappe.utils.bench_helper.app_group" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.bench_helper.<b>app_group</b>
<i class="text-muted">(ctx, site=False, force=False, verbose=False, profile=False)</i>
<i class="text-muted">()</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
......
frappe/docs/current/api/utils/frappe.utils.data.html
View file @ 3a73cbab
......@@ -926,6 +926,22 @@ Ported from PrettyDate by John Resig</p>
<p class="docs-attr-name">
<a name="frappe.utils.data.to_markdown" href="#frappe.utils.data.to_markdown" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.data.<b>to_markdown</b>
<i class="text-muted">(html)</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.data.to_timedelta" href="#frappe.utils.data.to_timedelta" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
......
frappe/docs/current/api/website/frappe.website.template.html deleted 100644 → 0
View file @ 0134ac78
<!-- title: frappe.website.template --><div class="dev-header">
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>
<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/website/template.py"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
</div>
<p class="docs-attr-name">
<a name="frappe.website.template.add_hero" href="#frappe.website.template.add_hero" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.website.template.<b>add_hero</b>
<i class="text-muted">(out, context)</i>
</p>
<div class="docs-attr-desc"><p>Add a hero element if specified in content or hooks.
Hero elements get full page width.</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.website.template.add_index" href="#frappe.website.template.add_index" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.website.template.<b>add_index</b>
<i class="text-muted">(out, context)</i>
</p>
<div class="docs-attr-desc"><p>Add index, next button if <code>{index}</code>, <code>{next}</code> is present.</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.website.template.build_template" href="#frappe.website.template.build_template" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.website.template.<b>build_template</b>
<i class="text-muted">(context)</i>
</p>
<div class="docs-attr-desc"><p>Returns a dict of block name and its rendered content</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.website.template.render_blocks" href="#frappe.website.template.render_blocks" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.website.template.<b>render_blocks</b>
<i class="text-muted">(template_path, out, context)</i>
</p>
<div class="docs-attr-desc"><p>Build the template block by block from the main template.</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.website.template.separate_style_and_script" href="#frappe.website.template.separate_style_and_script" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.website.template.<b>separate_style_and_script</b>
<i class="text-muted">(out, context)</i>
</p>
<div class="docs-attr-desc"><p>Extract <code>style</code> and <code>script</code> tags into separate blocks</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.website.template.set_breadcrumbs" href="#frappe.website.template.set_breadcrumbs" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.website.template.<b>set_breadcrumbs</b>
<i class="text-muted">(out, context)</i>
</p>
<div class="docs-attr-desc"><p>Build breadcrumbs template (deprecated)</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.website.template.set_title_and_header" href="#frappe.website.template.set_title_and_header" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.website.template.<b>set_title_and_header</b>
<i class="text-muted">(out, context)</i>
</p>
<div class="docs-attr-desc"><p>Extract and set title and header from content or context.</p>
</div>
<br>
<!-- autodoc -->
\ No newline at end of file
frappe/docs/current/api/website/index.txt
View file @ 3a73cbab
......@@ -3,6 +3,5 @@ frappe.website
frappe.website.render
frappe.website.router
frappe.website.statics
frappe.website.template
frappe.website.utils
frappe.website.website_generator
\ No newline at end of file
frappe/docs/current/index.html
View file @ 3a73cbab
......@@ -35,7 +35,7 @@
Version
</td>
<td>
<code>6.16.3</code>
<code>6.17.2</code>
</td>
</tr>
</table>
......
frappe/docs/current/models/core/comment.html
View file @ 3a73cbab
......@@ -73,7 +73,8 @@ Comment
Workflow
Label
Attachment
Attachment Removed</pre>
Attachment Removed
Like</pre>
</td>
</tr>
......
frappe/docs/current/models/core/communication.html
View file @ 3a73cbab
......@@ -571,20 +571,6 @@ Recipient Unsubscribed</pre>
<p class="docs-attr-name">
<a name="get_starrers" href="#get_starrers" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_starrers</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p>Return list of users who have starred this document.</p>
</div>
<br>
<p class="docs-attr-name">
<a name="notify" href="#notify" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
......
frappe/docs/current/models/core/user.html
View file @ 3a73cbab
......@@ -1068,9 +1068,9 @@ Website User</pre>
<p class="docs-attr-name">
<a name="send_password_notifcation" href="#send_password_notifcation" class="text-muted small">
<a name="send_password_notification" href="#send_password_notification" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>send_password_notifcation</b>
<b>send_password_notification</b>
<i class="text-muted">(self, new_password)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
......@@ -1595,8 +1595,6 @@ The mentions will be separated by non-word characters or may appear at the start
......
frappe/docs/current/models/desk/feed.html
View file @ 3a73cbab
......@@ -52,7 +52,8 @@
Comment
Login
Label
Info</pre>
Info
Like</pre>
</td>
</tr>
......@@ -116,6 +117,55 @@ Info</pre>
<td></td>
</tr>
<tr >
<td>7</td>
<td ><code>doc_owner</code></td>
<td >
Data</td>
<td >
Doc Owner
</td>
<td></td>
</tr>
<tr >
<td>8</td>
<td ><code>seen</code></td>
<td >
Check</td>
<td >
Seen
</td>
<td></td>
</tr>
<tr >
<td>9</td>
<td ><code>reference_doctype</code></td>
<td >
Data</td>
<td >
Reference DocType
<p class="text-muted small">
Use this to provide alternative link to a feed record</p>
</td>
<td></td>
</tr>
<tr >
<td>10</td>
<td ><code>reference_name</code></td>
<td >
Data</td>
<td >
Reference Name
</td>
<td></td>
</tr>
</tbody>
</table>
......@@ -138,6 +188,20 @@ Info</pre>
</div>
<div style="padding-left: 30px;">
<p class="docs-attr-name">
<a name="validate" href="#validate" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
</div>
<hr>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment