fix: Replace newlines with <br> tags in table descriptions

Issue-16: #16

Author: pawamoy

src/griffe2md/_internal/main.py

@@ -111,6 +111,7 @@ def prepare_env(env: Environment | None = None) -> Environment:
     env.filters["split_path"] = rendering.do_split_path
     env.filters["stash_crossref"] = lambda ref, length: ref
     env.filters["from_private_package"] = rendering.from_private_package
+    env.filters["newline_to_br"] = rendering._newline_to_br
 
     return env
 

src/griffe2md/_internal/rendering.py

@@ -498,3 +498,7 @@ def do_as_modules_section(modules: Sequence[Module], *, check_public: bool = Tru
             if not check_public or module.is_public or from_private_package(module)
         ],
     )
+
+
+def _newline_to_br(text: str) -> str:
+    return text.replace("\n\n", "<br>").replace("\n", " ")

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 }}
+[`{{ 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 }} }}
 {%- endfor -%}
 
 {%- elif config.docstring_section_style == "list" %}

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

@@ -5,7 +5,7 @@
 Name | Description
 ---- | -----------
 {%- for class in section.value %}
-[`{{ class.name }}`](#{{ obj.path }}.{{ class.name }}) | {{ class.description }}
+[`{{ class.name }}`](#{{ obj.path }}.{{ class.name }}) | {{ class.description|newline_to_br }}
 {%- endfor -%}
 
 {%- elif config.docstring_section_style == "list" %}

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

@@ -5,7 +5,7 @@
 Name | Description
 ---- | -----------
 {%- for function in section.value %}
-[`{{ function.name }}`](#{{ obj.path }}.{{ function.name }}) | {{ function.description }}
+[`{{ function.name }}`](#{{ obj.path }}.{{ function.name }}) | {{ function.description|newline_to_br }}
 {%- endfor -%}
 
 {%- elif config.docstring_section_style == "list" %}

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

@@ -5,7 +5,7 @@
 Name | Description
 ---- | -----------
 {%- for module in section.value %}
-[`{{ module.name }}`](#{{ obj.path }}.{{ module.name }}) | {{ module.description }}
+[`{{ module.name }}`](#{{ obj.path }}.{{ module.name }}) | {{ module.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 }}
+`{{ parameter.name }}` | {% if parameter.annotation -%}{%- with expression = parameter.annotation -%}<code>{%- include "expression.md.jinja" with context -%}</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 }} | {% 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>{%- 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 %}
 {%- 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 }}
+{%- if raises.annotation -%}{%- with expression = raises.annotation -%}<code>{%- include "expression.md.jinja" with context -%}</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 }}
+{%- 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 }}
 {% endfor %}
 
 {%- elif config.docstring_section_style == "list" %}