Skip to content

Commit abe2888

Browse files
pawamoypawamoy
committed
fix: Allow relative cross-references to work in summaries
Issue-331: #331
1 parent 0334131 commit abe2888

5 files changed

Lines changed: 19 additions & 19 deletions

File tree

‎src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html.jinja‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Context:
4343
</td>
4444
<td>
4545
<div class="doc-md-description">
46-
{{ attribute.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
46+
{{ attribute.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook|default(AutorefsHook(obj[attribute.name], config))) }}
4747
</div>
4848
</td>
4949
</tr>
@@ -66,7 +66,7 @@ Context:
6666
{% endif %}
6767
–
6868
<div class="doc-md-description">
69-
{{ attribute.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
69+
{{ attribute.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook|default(AutorefsHook(obj[attribute.name], config))) }}
7070
</div>
7171
</li>
7272
{% endfor %}
@@ -88,7 +88,7 @@ Context:
8888
<td><code><autoref identifier="{{ obj.path }}.{{ attribute.name }}" optional hover>{{ attribute.name }}</autoref></code></td>
8989
<td class="doc-attribute-details">
9090
<div class="doc-md-description">
91-
{{ attribute.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
91+
{{ attribute.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook|default(AutorefsHook(obj[attribute.name], config))) }}
9292
</div>
9393
<p>
9494
{% if attribute.annotation %}
@@ -106,4 +106,4 @@ Context:
106106
</tbody>
107107
</table>
108108
{% endblock spacy_style %}
109-
{% endif %}
109+
{% endif %}

‎src/mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html.jinja‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Context:
3535
<td><code><autoref identifier="{{ obj.path }}.{{ class.name }}" optional hover>{{ class.name }}</autoref></code></td>
3636
<td>
3737
<div class="doc-md-description">
38-
{{ class.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
38+
{{ class.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook|default(AutorefsHook(obj[class.name], config))) }}
3939
</div>
4040
</td>
4141
</tr>
@@ -53,7 +53,7 @@ Context:
5353
<b><code><autoref identifier="{{ obj.path }}.{{ class.name }}" optional hover>{{ class.name }}</autoref></code></b>
5454
–
5555
<div class="doc-md-description">
56-
{{ class.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
56+
{{ class.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook|default(AutorefsHook(obj[class.name], config))) }}
5757
</div>
5858
</li>
5959
{% endfor %}
@@ -75,12 +75,12 @@ Context:
7575
<td><code><autoref identifier="{{ obj.path }}.{{ class.name }}" optional hover>{{ class.name }}</autoref></code></td>
7676
<td class="doc-class-details">
7777
<div class="doc-md-description">
78-
{{ class.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
78+
{{ class.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook|default(AutorefsHook(obj[class.name], config))) }}
7979
</div>
8080
</td>
8181
</tr>
8282
{% endfor %}
8383
</tbody>
8484
</table>
8585
{% endblock spacy_style %}
86-
{% endif %}
86+
{% endif %}

‎src/mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html.jinja‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Context:
3636
<td><code><autoref identifier="{{ obj.path }}.{{ function.name }}" optional hover>{{ function.name }}</autoref></code></td>
3737
<td>
3838
<div class="doc-md-description">
39-
{{ function.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
39+
{{ function.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook|default(AutorefsHook(obj[function.name], config))) }}
4040
</div>
4141
</td>
4242
</tr>
@@ -56,7 +56,7 @@ Context:
5656
<b><code><autoref identifier="{{ obj.path }}.{{ function.name }}" optional hover>{{ function.name }}</autoref></code></b>
5757
–
5858
<div class="doc-md-description">
59-
{{ function.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
59+
{{ function.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook|default(AutorefsHook(obj[function.name], config))) }}
6060
</div>
6161
</li>
6262
{% endif %}
@@ -80,7 +80,7 @@ Context:
8080
<td><code><autoref identifier="{{ obj.path }}.{{ function.name }}" optional hover>{{ function.name }}</autoref></code></td>
8181
<td class="doc-function-details">
8282
<div class="doc-md-description">
83-
{{ function.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
83+
{{ function.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook|default(AutorefsHook(obj[function.name], config))) }}
8484
</div>
8585
</td>
8686
</tr>
@@ -89,4 +89,4 @@ Context:
8989
</tbody>
9090
</table>
9191
{% endblock spacy_style %}
92-
{% endif %}
92+
{% endif %}

‎src/mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html.jinja‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Context:
3535
<td><code><autoref identifier="{{ obj.path }}.{{ module.name }}" optional hover>{{ module.name }}</autoref></code></td>
3636
<td>
3737
<div class="doc-md-description">
38-
{{ module.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
38+
{{ module.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook|default(AutorefsHook(obj[module.name], config))) }}
3939
</div>
4040
</td>
4141
</tr>
@@ -53,7 +53,7 @@ Context:
5353
<b><code><autoref identifier="{{ obj.path }}.{{ module.name }}" optional hover>{{ module.name }}</autoref></code></b>
5454
–
5555
<div class="doc-md-description">
56-
{{ module.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
56+
{{ module.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook|default(AutorefsHook(obj[module.name], config))) }}
5757
</div>
5858
</li>
5959
{% endfor %}
@@ -75,12 +75,12 @@ Context:
7575
<td><code><autoref identifier="{{ obj.path }}.{{ module.name }}" optional hover>{{ module.name }}</autoref></code></td>
7676
<td class="doc-module-details">
7777
<div class="doc-md-description">
78-
{{ module.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
78+
{{ module.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook|default(AutorefsHook(obj[module.name], config))) }}
7979
</div>
8080
</td>
8181
</tr>
8282
{% endfor %}
8383
</tbody>
8484
</table>
8585
{% endblock spacy_style %}
86-
{% endif %}
86+
{% endif %}

‎src/mkdocstrings_handlers/python/templates/material/_base/docstring/type_aliases.html.jinja‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Context:
3535
<td><code><autoref identifier="{{ obj.path }}.{{ type_alias.name }}" optional hover>{{ type_alias.name }}</autoref></code></td>
3636
<td>
3737
<div class="doc-md-description">
38-
{{ type_alias.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
38+
{{ type_alias.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook|default(AutorefsHook(obj[type_alias.name], config))) }}
3939
</div>
4040
</td>
4141
</tr>
@@ -53,7 +53,7 @@ Context:
5353
<b><code><autoref identifier="{{ obj.path }}.{{ type_alias.name }}" optional hover>{{ type_alias.name }}</autoref></code></b>
5454
–
5555
<div class="doc-md-description">
56-
{{ type_alias.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
56+
{{ type_alias.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook|default(AutorefsHook(obj[type_alias.name], config))) }}
5757
</div>
5858
</li>
5959
{% endfor %}
@@ -75,7 +75,7 @@ Context:
7575
<td><code><autoref identifier="{{ obj.path }}.{{ type_alias.name }}" optional hover>{{ type_alias.name }}</autoref></code></td>
7676
<td class="doc-type_alias-details">
7777
<div class="doc-md-description">
78-
{{ type_alias.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
78+
{{ type_alias.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook|default(AutorefsHook(obj[type_alias.name], config))) }}
7979
</div>
8080
</td>
8181
</tr>

0 commit comments

Comments
 (0)