Implement seealso for plugins.

ansible-community · Feb 1, 2022 · 6b9b257 · 6b9b257
1 parent d01b5c9
commit 6b9b257
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 1 deletion.
diff --git a/src/antsibull/data/docsite/plugin.rst.j2 b/src/antsibull/data/docsite/plugin.rst.j2
@@ -280,6 +280,12 @@ See Also
 {%   elif item.module is defined %}
    @{ ('M(' + item['module'] + ')') | rst_ify }@
       The official documentation on the **@{ item['module'] }@** module.
+{%   elif item.plugin is defined and item.plugin_type is defined and item.description %}
+   @{ ('P(' + item['plugin'] + '#' + item['plugin_type'] + ')') | rst_ify }@ @{ item['plugin_type'] }@ plugin
+       @{ item['description'] | rst_ify }@
+{%   elif item.plugin is defined and item.plugin_type is defined %}
+   @{ ('P(' + item['plugin'] + '#' + item['plugin_type'] + ')') | rst_ify }@ @{ item['plugin_type'] }@ plugin
+      The official documentation on the **@{ item['plugin'] }@** @{ item['plugin_type'] }@ plugin.
 {%   elif item.name is defined and item.link is defined and item.description %}
    `@{ item['name'] }@ <@{ item['link'] }@>`_
        @{ item['description'] | rst_ify }@

diff --git a/src/antsibull/data/docsite/role.rst.j2 b/src/antsibull/data/docsite/role.rst.j2
@@ -158,6 +158,12 @@ See Also
 {%       elif item.module is defined %}
    @{ ('M(' + item['module'] + ')') | rst_ify }@
       The official documentation on the **@{ item['module'] }@** module.
+{%       elif item.plugin is defined and item.plugin_type is defined and item.description %}
+   @{ ('P(' + item['plugin'] + '#' + item['plugin_type'] + ')') | rst_ify }@ @{ item['plugin_type'] }@ plugin
+       @{ item['description'] | rst_ify }@
+{%       elif item.plugin is defined and item.plugin_type is defined %}
+   @{ ('P(' + item['plugin'] + '#' + item['plugin_type'] + ')') | rst_ify }@ @{ item['plugin_type'] }@ plugin
+      The official documentation on the **@{ item['plugin'] }@** @{ item['plugin_type'] }@ plugin.
 {%       elif item.name is defined and item.link is defined and item.description %}
    `@{ item['name'] }@ <@{ item['link'] }@>`_
        @{ item['description'] | rst_ify }@

diff --git a/src/antsibull/schemas/docs/base.py b/src/antsibull/schemas/docs/base.py
@@ -440,6 +440,12 @@ class SeeAlsoModSchema(BaseModel):
     description: str = ""
 
 
+class SeeAlsoPluginSchema(BaseModel):
+    plugin: str
+    plugin_type: str
+    description: str = ""
+
+
 class SeeAlsoRefSchema(BaseModel):
     description: str
     ref: str
@@ -505,7 +511,10 @@ class DocSchema(BaseModel):
     filename: str = ''
     notes: t.List[str] = []
     requirements: t.List[str] = []
-    seealso: t.List[t.Union[SeeAlsoModSchema, SeeAlsoRefSchema, SeeAlsoLinkSchema]] = []
+    seealso: t.List[t.Union[SeeAlsoModSchema,
+                            SeeAlsoPluginSchema,
+                            SeeAlsoRefSchema,
+                            SeeAlsoLinkSchema]] = []
     todo: t.List[str] = []
     version_added: str = 'historical'
     version_added_collection: str = COLLECTION_NAME_F