Skip to content

Reuse docstring template in several places #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
insolor merged 1 commit into from
Jul 25, 2025
Merged

Reuse docstring template in several places #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions src/mkdocstrings_handlers/zig/templates/material/_base/constant.html.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
{% if parent.node_type == "const" %}
<div class="constant" id="constant-{{ parent.short_signature }}">
{% filter heading(heading_level, id=html_id ~ parent.name) %}{{ parent.short_signature }}{% endfilter %}
{% if parent.doc %}
<div class="docstring">
{{ parent.doc | markdown | safe }}
</div>
{% endif %}
{% include "docstring.html.jinja" %}
</div>
{% endif %}
10 changes: 2 additions & 8 deletions src/mkdocstrings_handlers/zig/templates/material/_base/docstring.html.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
{% if data.doc %}
{% if parent.doc %}
<div class="docstring">
{{ data.doc | markdown | safe }}
{% if data.deprecated %}
<div class="admonition warning">
<p class="admonition-title">Deprecated</p>
{{ data.deprecated | markdown | safe }}
</div>
{% endif %}
{{ parent.doc | markdown | safe }}
</div>
{% endif %}
7 changes: 1 addition & 6 deletions src/mkdocstrings_handlers/zig/templates/material/_base/function.html.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,7 @@
</div>
{% endif %}

{% if parent.doc %}
<div class="docstring">
{{ parent.doc | markdown | safe }}
</div>
{% endif %}

{% include "docstring.html.jinja" %}
{% include "parameters.html.jinja" %}

{% with parent = parent.return_struct, heading_level = heading_level + 1 %}
Expand Down
2 changes: 1 addition & 1 deletion src/mkdocstrings_handlers/zig/templates/material/_base/module.html.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{% endblock logs %}

<div class="doc doc-object doc-data">
{% with obj = data, html_id = data.path %}
{% with parent = data, html_id = data.path %}
{% include "heading.html.jinja" %}

{% with heading_level=heading_level+1 %}
Expand Down
8 changes: 1 addition & 7 deletions src/mkdocstrings_handlers/zig/templates/material/_base/struct.html.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,7 @@
{% filter heading(heading_level, id=html_id ~ parent.name) %}{{ parent.short_signature }}{% endfilter %}
{% endif %}

{% if parent.doc %}
<div class="docstring">
{% with heading_level=heading_level + 1 %}
{{ parent.doc | markdown | safe }}
{% endwith %}
</div>
{% endif %}
{% include "docstring.html.jinja" %}

{% for child in parent.children %}
{% with parent = child, heading_level = heading_level + 1 %}
Expand Down
Loading