Merge pull request #223 from eccenca/feature/relatedPlugins-CMEM-7549

Add Related Plugins section to plugin reference pages

Author: rpietzsch

tools/templates/plugin.md

@@ -25,3 +25,12 @@ tags: {% for tag in plugin.tags %}
 ## Advanced Parameter
 
 {{parameters_advanced if plugin.properties_advanced else "`None`"}}
+
+{%- if plugin.relatedPlugins %}
+
+## Related Plugins
+
+{% for ref in plugin.relatedPlugins -%}
+- **{{ ref.id }}**{% if ref.description %} — {{ ref.description }}{% endif %}
+{% endfor %}
+{%- endif %}

tools/update_di_reference.py

@@ -27,6 +27,13 @@
 def stripped_single_line(value: str) -> str:
     return re.sub(r"\s+", " ", value).strip()
 
+class PluginReference(BaseModel):
+    """Reference to a related plugin."""
+
+    id: str
+    description: str | None = None
+
+
 class ActionDescription(BaseModel):
     """Action description"""
 
@@ -82,6 +89,7 @@ class PluginDescription(BaseModel):
     is_deprecated: bool | None = None
     tags: list[str] = Field(default_factory=list)
     pluginType: str | None = None
+    relatedPlugins: list[PluginReference] = Field(default_factory=list)
 
     @model_validator(mode="after")
     def move_advanced_properties(self) -> Self:
@@ -173,8 +181,8 @@ def create_plugin_markdown(plugin: PluginDescription, plugin_type: str, base_dir
 
     content = plugin_template.render(
         plugin=plugin,
-        parameters=parameter_content,
-        parameters_advanced=parameter_advanced_content,
+        parameters=parameter_content.rstrip("\n"),
+        parameters_advanced=parameter_advanced_content.rstrip("\n"),
     )
 
     # create the file (incl. directory)