Skip to content

Commit e9de94f

Browse files
committed
fix: Always wrap headings in backticks
Issue-11: #11
1 parent f6d962d commit e9de94f

File tree

4 files changed

+5
-9
lines changed

4 files changed

+5
-9
lines changed

src/griffe2md/templates/attribute.md.jinja

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
{% filter heading(heading_level) -%}
1515
{%- if config.separate_signature -%}
16-
{{ attribute_name }}
16+
`{{ attribute_name }}`
1717
{%- else -%}
1818
`{{- attribute_name }}{% if attribute.annotation -%}: {{ attribute.annotation }}{%- endif -%}`
1919
{%- endif -%}

src/griffe2md/templates/class.md.jinja

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,10 @@
1313

1414
{% filter heading(heading_level) -%}
1515
{%- if config.separate_signature -%}
16-
{{ class_name }}
16+
`{{ class_name }}`
1717
{%- elif config.merge_init_into_class and "__init__" in class.members -%}
1818
{%- with function = class.members["__init__"] -%}
19-
{{ class_name }}
20-
{%- include "signature.md.jinja" with context -%}
19+
`{{ class_name }}{% include "signature.md.jinja" with context %}`
2120
{%- endwith -%}
2221
{%- else -%}
2322
`{{ class_name }}`

src/griffe2md/templates/function.md.jinja

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,11 @@
1212
{%- if not root or config.show_root_heading %}
1313

1414
{% filter heading(heading_level) -%}
15-
{{ function_name }}
15+
`{{ function_name }}
1616
{%- if not config.separate_signature -%}
1717
{%- include "signature.md.jinja" with context -%}
1818
{%- endif -%}
19+
`
1920
{%- endfilter -%}
2021

2122
{%- if config.separate_signature -%}

src/griffe2md/templates/module.md.jinja

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,7 @@
1212
{%- if not root or config.show_root_heading %}
1313

1414
{% filter heading(heading_level) -%}
15-
{%- if config.separate_signature -%}
16-
{{ module_name }}
17-
{%- else -%}
1815
`{{ module_name }}`
19-
{%- endif -%}
2016
{%- endfilter -%}
2117

2218
{%- else -%}

0 commit comments

Comments
 (0)