Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit 3bcbd63

Browse files
chore(docs): add horizontal rules between known issues
1 parent c8e09c8 commit 3bcbd63

File tree

2 files changed

+63
-1
lines changed

2 files changed

+63
-1
lines changed
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
{% extends "base.template.html" %}
2+
3+
{% block content %}
4+
5+
{% block header %}
6+
<header class="api-profile-header">
7+
<h1 class="api-profile-header-heading">{$ doc.name $}</h1>
8+
<ol class="api-profile-header-structure naked-list step-list">
9+
{% block related_components %}{% endblock %}
10+
<li>
11+
- {$ doc.docType $} in module {$ doc.moduleDoc.id | link(doc.moduleDoc.name, doc.moduleDoc) $}
12+
</li>
13+
</ol>
14+
</header>
15+
{% endblock %}
16+
17+
{% block description %}
18+
<div class="api-profile-description">
19+
{$ doc.description | marked $}
20+
</div>
21+
{% endblock %}
22+
23+
{% if doc.knownIssues %}
24+
<h2 id="known-issues">Known Issues</h2>
25+
{% for issue in doc.knownIssues -%}
26+
<div class="known-issue">
27+
{$ issue | marked $} {% if not loop.last %}<hr>{% endif %}
28+
</div>
29+
{% endfor -%}
30+
{% endif %}
31+
32+
{% if doc.deprecated %}
33+
<fieldset class="deprecated">
34+
<legend>Deprecated API</legend>
35+
{$ doc.deprecated| marked $}
36+
</fieldset>
37+
{% endif %}
38+
39+
<div>
40+
{% block dependencies %}
41+
{%- if doc.requires %}
42+
<h2 id="dependencies">Dependencies</h2>
43+
<ul>
44+
{% for require in doc.requires %}<li>{$ require | link $}</li>{% endfor %}
45+
</ul>
46+
{% endif -%}
47+
{% endblock %}
48+
49+
{% block additional %}
50+
{% endblock %}
51+
52+
{% block examples %}
53+
{%- if doc.examples %}
54+
<h2 id="example">Example</h2>
55+
{%- for example in doc.examples -%}
56+
{$ example | marked $}
57+
{%- endfor -%}
58+
{% endif -%}
59+
{% endblock %}
60+
</div>
61+
62+
{% endblock %}

docs/config/templates/api/module.template.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ <h2 id="known-issues">Known Issues</h2>
5959
<td>{$ issueDoc.id | link(issueDoc.name, issueDoc) $}</td>
6060
<td>
6161
{% for issue in issueDoc.knownIssues -%}
62-
{$ issue | marked $}
62+
{$ issue | marked $} {% if not loop.last %}<hr>{% endif %}
6363
{% endfor -%}
6464
</td>
6565
</tr>

0 commit comments

Comments
 (0)