Skip to content

Add Related Plugins section to plugin reference pages #223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
edufuga wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Related Plugins section to plugin reference pages #223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions tools/templates/plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
12 changes: 10 additions & 2 deletions tools/update_di_reference.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"""

Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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)
Expand Down
Loading