Selaa lähdekoodia

[docs] [fixes]

version-14
Rushabh Mehta 9 vuotta sitten
vanhempi
commit
8228cf183c
9 muutettua tiedostoa jossa 253 lisäystä ja 248 poistoa
  1. +1
    -1
      frappe/config/docs.py
  2. +1
    -1
      frappe/docs/current/api/utils/frappe.utils.bench_helper.html
  3. +227
    -227
      frappe/docs/current/api/utils/frappe.utils.html
  4. +1
    -1
      frappe/docs/index.html
  5. +4
    -4
      frappe/public/css/docs.css
  6. +4
    -4
      frappe/public/less/docs.less
  7. +1
    -1
      frappe/utils/__init__.py
  8. +11
    -8
      frappe/website/template.py
  9. +3
    -1
      frappe/website/website_generator.py

+ 1
- 1
frappe/config/docs.py Näytä tiedosto

@@ -20,7 +20,7 @@ to ERPNext.
Frappe Framework was designed to build [ERPNext](https://erpnext.com), open source
ERP for managing small and medium sized businesses.

[Get started with the Tutorial](https://github.frappe.io/frappe/user/tutorial)
[Get started with the Tutorial](https://frappe.github.io/frappe/user/tutorial)
"""
docs_version = "6.x.x"



+ 1
- 1
frappe/docs/current/api/utils/frappe.utils.bench_helper.html Näytä tiedosto

@@ -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">()</i>
<i class="text-muted">(ctx, site=False, force=False, verbose=False, profile=False)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>


+ 227
- 227
frappe/docs/current/api/utils/frappe.utils.html Näytä tiedosto

@@ -13,10 +13,10 @@



<p class="docs-attr-name">
<a name="frappe.utils.call_hook_method" href="#frappe.utils.call_hook_method" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -27,12 +27,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.decode_dict" href="#frappe.utils.decode_dict" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -43,12 +43,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.dict_to_str" href="#frappe.utils.dict_to_str" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -59,12 +59,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.encode_dict" href="#frappe.utils.encode_dict" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -75,12 +75,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.esc" href="#frappe.utils.esc" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -91,12 +91,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.execute_in_shell" href="#frappe.utils.execute_in_shell" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -107,12 +107,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.extract_email_id" href="#frappe.utils.extract_email_id" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -123,12 +123,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.getCSVelement" href="#frappe.utils.getCSVelement" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -144,12 +144,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_backups_path" href="#frappe.utils.get_backups_path" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -160,12 +160,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_bench_path" href="#frappe.utils.get_bench_path" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -176,12 +176,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_common" href="#frappe.utils.get_common" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -192,12 +192,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_common_dict" href="#frappe.utils.get_common_dict" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -208,12 +208,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_defaults" href="#frappe.utils.get_defaults" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -224,12 +224,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_diff_dict" href="#frappe.utils.get_diff_dict" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -240,12 +240,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_disk_usage" href="#frappe.utils.get_disk_usage" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -256,12 +256,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_file_timestamp" href="#frappe.utils.get_file_timestamp" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -272,12 +272,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_files_path" href="#frappe.utils.get_files_path" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -288,28 +288,28 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_formatted_email" href="#frappe.utils.get_formatted_email" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.utils.<b>get_formatted_email</b>
<i class="text-muted">(user)</i>
</p>
<div class="docs-attr-desc"><p>get email id of user formatted as: John Doe <a href="&#109;&#x61;&#105;&#x6c;&#x74;&#111;&#58;&#x6a;&#111;hn&#x64;o&#101;&#x40;&#x65;x&#x61;&#x6d;&#112;l&#101;&#x2e;&#x63;&#111;&#x6d;">&#x6a;&#111;hn&#x64;o&#101;&#x40;&#x65;x&#x61;&#x6d;&#112;l&#101;&#x2e;&#x63;&#111;&#x6d;</a></p>
<div class="docs-attr-desc"><p>get email id of user formatted as: <code>John Doe <johndoe@example.com></code></p>
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_fullname" href="#frappe.utils.get_fullname" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -320,12 +320,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_gravatar" href="#frappe.utils.get_gravatar" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -336,12 +336,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_hook_method" href="#frappe.utils.get_hook_method" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -352,12 +352,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_html_format" href="#frappe.utils.get_html_format" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -368,12 +368,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_path" href="#frappe.utils.get_path" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -384,12 +384,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_request_session" href="#frappe.utils.get_request_session" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -400,12 +400,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_request_site_address" href="#frappe.utils.get_request_site_address" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -416,12 +416,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_site_base_path" href="#frappe.utils.get_site_base_path" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -432,12 +432,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_site_name" href="#frappe.utils.get_site_name" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -448,12 +448,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_site_path" href="#frappe.utils.get_site_path" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -464,12 +464,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_sites" href="#frappe.utils.get_sites" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -480,12 +480,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_test_client" href="#frappe.utils.get_test_client" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -496,12 +496,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.get_traceback" href="#frappe.utils.get_traceback" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -512,12 +512,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.is_markdown" href="#frappe.utils.is_markdown" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -528,12 +528,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.log" href="#frappe.utils.log" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -544,12 +544,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.make_esc" href="#frappe.utils.make_esc" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -560,12 +560,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.pprint_dict" href="#frappe.utils.pprint_dict" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -576,12 +576,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.random_string" href="#frappe.utils.random_string" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -592,12 +592,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.remove_blanks" href="#frappe.utils.remove_blanks" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -608,12 +608,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.set_default" href="#frappe.utils.set_default" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -624,12 +624,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.split_emails" href="#frappe.utils.split_emails" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -640,12 +640,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.strip_html_tags" href="#frappe.utils.strip_html_tags" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -656,12 +656,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.touch_file" href="#frappe.utils.touch_file" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -672,12 +672,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.unesc" href="#frappe.utils.unesc" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -688,12 +688,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.update_progress_bar" href="#frappe.utils.update_progress_bar" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -704,12 +704,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.validate_email_add" href="#frappe.utils.validate_email_add" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -720,12 +720,12 @@
</div>
<br>







<p class="docs-attr-name">
<a name="frappe.utils.watch" href="#frappe.utils.watch" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
@@ -736,8 +736,8 @@
</div>
<br>




<!-- autodoc -->

<!-- autodoc -->

+ 1
- 1
frappe/docs/index.html Näytä tiedosto

@@ -44,7 +44,7 @@ to ERPNext.</p>
<p>Frappe Framework was designed to build <a href="https://erpnext.com">ERPNext</a>, open source
ERP for managing small and medium sized businesses.</p>

<p><a href="https://github.frappe.io/frappe/user/tutorial">Get started with the Tutorial</a></p>
<p><a href="https://frappe.github.io/frappe/user/tutorial">Get started with the Tutorial</a></p>

</div>
</div>


+ 4
- 4
frappe/public/css/docs.css Näytä tiedosto

@@ -448,7 +448,8 @@ a.btn-primary:visited {
color: #fff;
}
.btn-next-wrapper {
margin: 32px 0 16px;
margin-top: 32px;
text-align: right;
}
h2 {
margin-top: 48px;
@@ -576,7 +577,6 @@ hr {
background: url('/assets/img/smiley.png') 0% 50% no-repeat;
color: #8d99a6;
display: block;
margin-top: -22px;
}
a.edit,
a.edit:hover,
@@ -585,8 +585,8 @@ a.edit:visited {
color: #8d99a6;
}
.btn-next {
margin-top: 16px;
float: right;
margin-top: 30px;
margin-bottom: 0px;
}
.btn-next:after {
content: " \2192";


+ 4
- 4
frappe/public/less/docs.less Näytä tiedosto

@@ -206,7 +206,8 @@ a.btn-primary& {
}

.btn-next-wrapper {
margin:32px 0 16px;
margin-top: 32px;
text-align: right;
}

h2 {
@@ -356,15 +357,14 @@ hr {
background:url('/assets/img/smiley.png') 0% 50% no-repeat;
color: #8d99a6;
display: block;
margin-top: -22px;
}
a.edit, a.edit:hover, a.edit:focus, a.edit:visited {
color:#8d99a6;
}

.btn-next {
margin-top:16px;
float:right;
margin-top: 30px;
margin-bottom: 0px;
}
.btn-next:after {
content:" \2192";


+ 1
- 1
frappe/utils/__init__.py Näytä tiedosto

@@ -50,7 +50,7 @@ def get_fullname(user=None):
return frappe.local.fullnames.get(user)

def get_formatted_email(user):
"""get email id of user formatted as: John Doe <johndoe@example.com>"""
"""get email id of user formatted as: `John Doe <johndoe@example.com>`"""
if user == "Administrator":
return user
from email.utils import formataddr


+ 11
- 8
frappe/website/template.py Näytä tiedosto

@@ -130,17 +130,20 @@ def add_index(out, context):
if "{next}" in out.get("content", ""):
next_item = context.doc.get_next()
next_item.extn = "" if context.doc.has_children(next_item.name) else extn
if context.relative_links:
next_item.name = next_item.page_name or ""
else:
if next_item and next_item.name and next_item.name[0]!="/":
next_item.name = "/" + next_item.name
if next_item and next_item.page_name:
if context.relative_links:
if next_item.next_parent:
next_item.name = "../" + next_item.page_name or ""
else:
next_item.name = next_item.page_name or ""
else:
if next_item and next_item.name and next_item.name[0]!="/":
next_item.name = "/" + next_item.name

if next_item and next_item.name:
if not next_item.title:
next_item.title = ""
html = ('<p class="btn-next-wrapper"><a class="btn-next" href="{name}{extn}">'\
+_("Next")+': {title}</a></p>').format(**next_item)
html = ('<p class="btn-next-wrapper">'+_("Next")\
+': <a class="btn-next" href="{name}{extn}">{title}</a></p>').format(**next_item)
else:
html = ""



+ 3
- 1
frappe/website/website_generator.py Näytä tiedosto

@@ -246,7 +246,9 @@ class WebsiteGenerator(Document):
if route==r.name:
return siblings[i+1]

return parent.get_next()
out = parent.get_next()
out.next_parent = True
return out
else:
return frappe._dict()



Ladataan…
Peruuta
Tallenna