mirror of
https://github.com/YunoHost/yunohost.git
synced 2024-09-03 20:06:10 +02:00
Update template for the new doc (grav)
This commit is contained in:
Kay0u
parent
3bbc93d54b
commit
59d3e387f1
4 changed files with 62 additions and 115 deletions
|
|
@ -14,7 +14,7 @@ generate-helpers-doc:
|
||||||
- cd doc
|
- cd doc
|
||||||
- python generate_helper_doc.py
|
- python generate_helper_doc.py
|
||||||
- hub clone https://$GITHUB_TOKEN:x-oauth-basic@github.com/YunoHost/doc.git doc_repo
|
- hub clone https://$GITHUB_TOKEN:x-oauth-basic@github.com/YunoHost/doc.git doc_repo
|
||||||
- cp helpers.html doc_repo/packaging_apps_helpers.md
|
- cp helpers.md doc_repo/pages/02.contribute/04.packaging_apps/11.helpers/packaging_apps_helpers.md
|
||||||
- cd doc_repo
|
- cd doc_repo
|
||||||
# replace ${CI_COMMIT_REF_NAME} with ${CI_COMMIT_TAG} ?
|
# replace ${CI_COMMIT_REF_NAME} with ${CI_COMMIT_TAG} ?
|
||||||
- hub checkout -b "${CI_COMMIT_REF_NAME}"
|
- hub checkout -b "${CI_COMMIT_REF_NAME}"
|
||||||
|
|
|
||||||
|
|
@ -39,7 +39,7 @@ def render(helpers):
|
||||||
def shell_to_html(shell):
|
def shell_to_html(shell):
|
||||||
return conv.convert(shell, False)
|
return conv.convert(shell, False)
|
||||||
|
|
||||||
template = open("helper_doc_template.html", "r").read()
|
template = open("helper_doc_template.md", "r").read()
|
||||||
t = Template(template)
|
t = Template(template)
|
||||||
t.globals["now"] = datetime.datetime.utcnow
|
t.globals["now"] = datetime.datetime.utcnow
|
||||||
result = t.render(
|
result = t.render(
|
||||||
|
|
@ -48,7 +48,7 @@ def render(helpers):
|
||||||
convert=shell_to_html,
|
convert=shell_to_html,
|
||||||
shell_css=shell_css,
|
shell_css=shell_css,
|
||||||
)
|
)
|
||||||
open("helpers.html", "w").write(result)
|
open("helpers.md", "w").write(result)
|
||||||
|
|
||||||
|
|
||||||
##############################################################################
|
##############################################################################
|
||||||
|
|
|
||||||
|
|
@ -1,112 +0,0 @@
|
||||||
<!-- NO_MARKDOWN_PARSING -->
|
|
||||||
|
|
||||||
<h1>App helpers</h1>
|
|
||||||
|
|
||||||
<p>Doc auto-generated by <a href="https://github.com/YunoHost/yunohost/blob/{{ current_commit }}/doc/generate_helper_doc.py">this script</a> on {{data.date}} (Yunohost version {{data.version}})</p>
|
|
||||||
|
|
||||||
{% for category, helpers in data.helpers %}
|
|
||||||
|
|
||||||
<h3 style="text-transform: uppercase; font-weight: bold">{{ category }}</h3>
|
|
||||||
|
|
||||||
{% for h in helpers %}
|
|
||||||
|
|
||||||
<div class="helper-card">
|
|
||||||
<div class="helper-card-body">
|
|
||||||
<div data-toggle="collapse" href="#collapse-{{ h.name }}" style="cursor:pointer">
|
|
||||||
<h5 class="helper-card-title"><tt>{{ h.name }}</tt></h5>
|
|
||||||
<h6 class="helper-card-subtitle text-muted">{{ h.brief }}</h6>
|
|
||||||
</div>
|
|
||||||
<div id="collapse-{{ h.name }}" class="collapse" role="tabpanel">
|
|
||||||
<hr style="margin-top:25px; margin-bottom:25px;">
|
|
||||||
<p>
|
|
||||||
{% if not '\n' in h.usage %}
|
|
||||||
<strong>Usage</strong>: <code class="helper-code">{{ h.usage }}</code>
|
|
||||||
{% else %}
|
|
||||||
<strong>Usage</strong>: <code class="helper-code helper-usage">{{ h.usage }}</code>
|
|
||||||
{% endif %}
|
|
||||||
</p>
|
|
||||||
{% if h.args %}
|
|
||||||
<p>
|
|
||||||
<strong>Arguments</strong>:
|
|
||||||
<ul>
|
|
||||||
{% for infos in h.args %}
|
|
||||||
{% if infos|length == 2 %}
|
|
||||||
<li><code>{{ infos[0] }}</code> : {{ infos[1] }}</li>
|
|
||||||
{% else %}
|
|
||||||
<li><code>{{ infos[0] }}</code>, <code>{{ infos[1] }}</code> : {{ infos[2] }}</li>
|
|
||||||
{% endif %}
|
|
||||||
{% endfor %}
|
|
||||||
</ul>
|
|
||||||
</p>
|
|
||||||
{% endif %}
|
|
||||||
{% if h.ret %}
|
|
||||||
<p>
|
|
||||||
<strong>Returns</strong>: {{ h.ret }}
|
|
||||||
</p>
|
|
||||||
{% endif %}
|
|
||||||
{% if "example" in h.keys() %}
|
|
||||||
<p>
|
|
||||||
<strong>Example</strong>: <code class="helper-code">{{ h.example }}</code>
|
|
||||||
</p>
|
|
||||||
{% endif %}
|
|
||||||
{% if "examples" in h.keys() %}
|
|
||||||
<p>
|
|
||||||
<strong>Examples</strong>:<ul>
|
|
||||||
{% for example in h.examples %}
|
|
||||||
{% if not example.strip().startswith("# ") %}
|
|
||||||
<code class="helper-code">{{ example }}</code>
|
|
||||||
{% else %}
|
|
||||||
{{ example.strip("# ") }}
|
|
||||||
{% endif %}
|
|
||||||
<br>
|
|
||||||
{% endfor %}
|
|
||||||
</ul>
|
|
||||||
</p>
|
|
||||||
{% endif %}
|
|
||||||
{% if h.details %}
|
|
||||||
<p>
|
|
||||||
<strong>Details</strong>:
|
|
||||||
<p>
|
|
||||||
{{ h.details.replace('\n', '</br>') }}
|
|
||||||
</p>
|
|
||||||
</p>
|
|
||||||
{% endif %}
|
|
||||||
<p>
|
|
||||||
<a href="https://github.com/YunoHost/yunohost/blob/{{ current_commit }}/data/helpers.d/{{ category }}#L{{ h.line + 1 }}">Dude, show me the code !</a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
{% endfor %}
|
|
||||||
{% endfor %}
|
|
||||||
|
|
||||||
<style>
|
|
||||||
/*=================================================
|
|
||||||
Helper card
|
|
||||||
=================================================*/
|
|
||||||
.helper-card {
|
|
||||||
width:100%;
|
|
||||||
min-height: 1px;
|
|
||||||
margin-right: 10px;
|
|
||||||
margin-left: 10px;
|
|
||||||
border: 1px solid rgba(0,0,0,.125);
|
|
||||||
border-radius: 0.5rem;
|
|
||||||
word-wrap: break-word;
|
|
||||||
margin-top: 0.5rem;
|
|
||||||
margin-bottom: 0.5rem;
|
|
||||||
}
|
|
||||||
.helper-card-body {
|
|
||||||
padding: 1.25rem;
|
|
||||||
padding-top: 0.8rem;
|
|
||||||
padding-bottom: 0;
|
|
||||||
}
|
|
||||||
.helper-code {
|
|
||||||
word-wrap: break-word;
|
|
||||||
white-space: normal;
|
|
||||||
}
|
|
||||||
/*===============================================*/
|
|
||||||
|
|
||||||
</style>
|
|
||||||
59
doc/helper_doc_template.md
Normal file
59
doc/helper_doc_template.md
Normal file
|
|
@ -0,0 +1,59 @@
|
||||||
|
---
|
||||||
|
title: App helpers
|
||||||
|
template: docs
|
||||||
|
taxonomy:
|
||||||
|
category: docs
|
||||||
|
routes:
|
||||||
|
default: '/packaging_apps_helpers'
|
||||||
|
---
|
||||||
|
|
||||||
|
Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/{{ current_commit }}/doc/generate_helper_doc.py) on {{data.date}} (Yunohost version {{data.version}})
|
||||||
|
|
||||||
|
{% for category, helpers in data.helpers %}
|
||||||
|
### {{ category.upper() }}
|
||||||
|
{% for h in helpers %}
|
||||||
|
**{{ h.name }}**
|
||||||
|
[details summary="<i>{{ h.brief }}</i>" class="helper-card-subtitle text-muted"]
|
||||||
|
<p></p>
|
||||||
|
|
||||||
|
**Usage**: `{{ h.usage }}`
|
||||||
|
{% if h.args %}
|
||||||
|
|
||||||
|
**Arguments**:
|
||||||
|
{% for infos in h.args %}
|
||||||
|
{% if infos|length == 2 %}
|
||||||
|
- `{{ infos[0] }}`: {{ infos[1] }}
|
||||||
|
{% else %}
|
||||||
|
- `{{ infos[0] }}`, `{{ infos[1] }}`: {{ infos[2] }}
|
||||||
|
{% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
{% endif %}
|
||||||
|
{% if h.ret %}
|
||||||
|
|
||||||
|
**Returns**: {{ h.ret }}
|
||||||
|
{% endif %}
|
||||||
|
{% if "example" in h.keys() %}
|
||||||
|
**Example**: `{{ h.example }}`
|
||||||
|
{% endif %}
|
||||||
|
{% if "examples" in h.keys() %}
|
||||||
|
|
||||||
|
**Examples**:
|
||||||
|
{% for example in h.examples %}
|
||||||
|
{% if not example.strip().startswith("# ") %}
|
||||||
|
- `{{ example }}`
|
||||||
|
{% else %}
|
||||||
|
- `{{ example.strip("# ") }}`
|
||||||
|
{% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
{% endif %}
|
||||||
|
{% if h.details %}
|
||||||
|
|
||||||
|
**Details**:
|
||||||
|
{{ h.details.replace('\n', '</br>').replace('_', '\_') }}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
[Dude, show me the code!](https://github.com/YunoHost/yunohost/blob/{{ current_commit }}/data/helpers.d/{{ category }}#L{{ h.line + 1 }})
|
||||||
|
[/details]
|
||||||
|
----------------
|
||||||
|
{% endfor %}
|
||||||
|
{% endfor %}
|
||||||
Loading…
Add table
Reference in a new issue