fix: Escape pipes in table cells

Issue-22: #22

Author: pawamoy

src/griffe2md/templates/docstring/attributes.md.jinja

@@ -5,7 +5,7 @@
 Name | Type | Description
 ---- | ---- | -----------
 {%- for attribute in section.value %}
-[`{{ attribute.name }}`](#{{ obj.path }}.{{ attribute.name }}) | {% if attribute.annotation -%}{%- with expression = attribute.annotation -%}<code>{%- include "expression.md.jinja" with context -%}</code>{%- endwith -%}{%- endif %} | {{ attribute.description|newline_to_br }} }}
+[`{{ attribute.name }}`](#{{ obj.path }}.{{ attribute.name }}) | {% if attribute.annotation -%}{%- with expression = attribute.annotation -%}<code>{% filter replace("|", "\\|") %}{%- include "expression.md.jinja" with context -%}{% endfilter %}</code>{%- endwith -%}{%- endif %} | {{ attribute.description|newline_to_br }} }}
 {%- endfor -%}
 
 {%- elif config.docstring_section_style == "list" %}

src/griffe2md/templates/docstring/other_parameters.md.jinja

@@ -5,7 +5,7 @@
 Name | Type | Description
 ---- | ---- | -----------
 {%- for parameter in section.value %}
-`{{ parameter.name }}` | {% if parameter.annotation -%}{%- with expression = parameter.annotation -%}<code>{%- include "expression.md.jinja" with context -%}</code>{%- endwith -%}{%- endif %} | {{ parameter.description|newline_to_br }}
+`{{ parameter.name }}` | {% if parameter.annotation -%}{%- with expression = parameter.annotation -%}<code>{% filter replace("|", "\\|") %}{%- include "expression.md.jinja" with context -%}{% endfilter %}</code>{%- endwith -%}{%- endif %} | {{ parameter.description|newline_to_br }}
 {%- endfor -%}
 
 {%- elif config.docstring_section_style == "list" %}

src/griffe2md/templates/docstring/parameters.md.jinja

@@ -5,7 +5,7 @@
 Name | Type | Description | Default
 ---- | ---- | ----------- | -------
 {%- for parameter in section.value %}
-`{{ parameter.name }}` | {% if parameter.annotation -%}{%- with expression = parameter.annotation -%}<code>{%- include "expression.md.jinja" with context -%}</code>{%- endwith -%}{%- endif %} | {{ parameter.description|newline_to_br }} | {% if parameter.default -%}{%- with expression = parameter.default -%}<code>{%- include "expression.md.jinja" with context -%}</code>{%- endwith -%}{%- else -%}*required*{%- endif %}
+`{{ parameter.name }}` | {% if parameter.annotation -%}{%- with expression = parameter.annotation -%}<code>{% filter replace("|", "\\|") %}{%- include "expression.md.jinja" with context -%}{% endfilter %}</code>{%- endwith -%}{%- endif %} | {{ parameter.description|newline_to_br }} | {% if parameter.default -%}{%- with expression = parameter.default -%}<code>{% filter replace("|", "\\|") %}{%- include "expression.md.jinja" with context -%}{% endfilter %}</code>{%- endwith -%}{%- else -%}*required*{%- endif %}
 {%- endfor -%}
 
 {%- elif config.docstring_section_style == "list" %}

src/griffe2md/templates/docstring/raises.md.jinja

@@ -5,7 +5,7 @@
 Type | Description
 ---- | -----------
 {% for raises in section.value %}
-{%- if raises.annotation -%}{%- with expression = raises.annotation -%}<code>{%- include "expression.md.jinja" with context -%}</code>{%- endwith -%}{%- endif -%} | {{ raises.description|newline_to_br }}
+{%- if raises.annotation -%}{%- with expression = raises.annotation -%}<code>{% filter replace("|", "\\|") %}{%- include "expression.md.jinja" with context -%}{% endfilter %}</code>{%- endwith -%}{%- endif -%} | {{ raises.description|newline_to_br }}
 {% endfor %}
 
 {%- elif config.docstring_section_style == "list" %}

src/griffe2md/templates/docstring/receives.md.jinja

@@ -6,7 +6,7 @@
 {% if name_column -%}Name | {% endif -%}Type | Description
 {% if name_column -%}---- | {% endif -%}---- | -----------
 {% for receives in section.value %}
-{%- if name_column -%}{%- if receives.name -%}`{{ receives.name }}`{%- endif %} | {% endif %}{% if receives.annotation -%}{%- with expression = receives.annotation -%}<code>{%- include "expression.md.jinja" with context -%}</code>{%- endwith -%}{%- endif %} | {{ receives.description|newline_to_br }}
+{%- if name_column -%}{%- if receives.name -%}`{{ receives.name }}`{%- endif %} | {% endif %}{% if receives.annotation -%}{%- with expression = receives.annotation -%}<code>{% filter replace("|", "\\|") %}{%- include "expression.md.jinja" with context -%}{% endfilter %}</code>{%- endwith -%}{%- endif %} | {{ receives.description|newline_to_br }}
 {% endfor %}
 
 {%- elif config.docstring_section_style == "list" %}

src/griffe2md/templates/docstring/returns.md.jinja

@@ -6,7 +6,7 @@
 {% if name_column -%}Name | {% endif -%}Type | Description
 {% if name_column -%}---- | {% endif -%}---- | -----------
 {% for returns in section.value %}
-{%- if name_column -%}{%- if returns.name -%}`{{ returns.name }}`{%- endif %} | {% endif %}{% if returns.annotation -%}{%- with expression = returns.annotation -%}<code>{%- include "expression.md.jinja" with context -%}</code>{%- endwith -%}{%- endif %} | {{ returns.description|newline_to_br }}
+{%- if name_column -%}{%- if returns.name -%}`{{ returns.name }}`{%- endif %} | {% endif %}{% if returns.annotation -%}{%- with expression = returns.annotation -%}<code>{% filter replace("|", "\\|") %}{%- include "expression.md.jinja" with context -%}{% endfilter %}</code>{%- endwith -%}{%- endif %} | {{ returns.description|newline_to_br }}
 {% endfor %}
 
 {%- elif config.docstring_section_style == "list" %}

src/griffe2md/templates/docstring/warns.md.jinja

@@ -5,7 +5,7 @@
 Type | Description
 ---- | -----------
 {% for warns in section.value %}
-{%- if warns.annotation -%}{%- with expression = warns.annotation -%}<code>{%- include "expression.md.jinja" with context -%}</code>{%- endwith -%}{%- endif -%} | {{ warns.description|newline_to_br }}
+{%- if warns.annotation -%}{%- with expression = warns.annotation -%}<code>{% filter replace("|", "\\|") %}{%- include "expression.md.jinja" with context -%}{% endfilter %}</code>{%- endwith -%}{%- endif -%} | {{ warns.description|newline_to_br }}
 {% endfor %}
 
 {%- elif config.docstring_section_style == "list" %}

src/griffe2md/templates/docstring/yields.md.jinja

@@ -6,7 +6,7 @@
 {% if name_column -%}Name | {% endif -%}Type | Description
 {% if name_column -%}---- | {% endif -%}---- | -----------
 {% for yields in section.value %}
-{%- if name_column -%}{%- if yields.name -%}`{{ yields.name }}`{%- endif %} | {% endif -%}{%- if yields.annotation -%}{%- with expression = yields.annotation -%}<code>{%- include "expression.md.jinja" with context -%}</code>{%- endwith -%}{%- endif %} | {{ yields.description|newline_to_br }}
+{%- if name_column -%}{%- if yields.name -%}`{{ yields.name }}`{%- endif %} | {% endif -%}{%- if yields.annotation -%}{%- with expression = yields.annotation -%}<code>{% filter replace("|", "\\|") %}{%- include "expression.md.jinja" with context -%}{% endfilter %}</code>{%- endwith -%}{%- endif %} | {{ yields.description|newline_to_br }}
 {% endfor %}
 
 {%- elif config.docstring_section_style == "list" %}