@@ -29,10 +29,10 @@
{% endfor %}
loop.depth %} colspan="@{ table_depth - loop.depth0 }@"{% endif %} valign="top">
{% for full_key in value['full_keys'] %}
-
+
{% endfor %}
- @{ key | escape }@
-
+ @{ key | escape }@
+
{% if value['aliases'] %}
aliases: @{ value['aliases']|join(', ') }@
{% endif %}
diff --git a/src/antsibull_docs/data/docsite/simplified-rst/macros/returnvalues.rst.j2 b/src/antsibull_docs/data/docsite/simplified-rst/macros/returnvalues.rst.j2
index 603e4a63..4788a96f 100644
--- a/src/antsibull_docs/data/docsite/simplified-rst/macros/returnvalues.rst.j2
+++ b/src/antsibull_docs/data/docsite/simplified-rst/macros/returnvalues.rst.j2
@@ -30,8 +30,8 @@
{% for full_key in value['full_keys'] %}
{% endfor %}
- @{ key | escape }@
-
+ @{ key | escape }@
+
@{ value['type'] | documented_type }@
{% if value['type'] == 'list' and value['elements'] is not none %}
diff --git a/src/antsibull_docs/data/docsite/simplified-rst/role.rst.j2 b/src/antsibull_docs/data/docsite/simplified-rst/role.rst.j2
index 8f83fc36..43438f2d 100644
--- a/src/antsibull_docs/data/docsite/simplified-rst/role.rst.j2
+++ b/src/antsibull_docs/data/docsite/simplified-rst/role.rst.j2
@@ -93,7 +93,7 @@ The below requirements are needed on the remote host and/or the local controller
Parameters
^^^^^^^^^^
-@{ parameters_html(ep_doc['options'] | dictsort, suboption_key='options', parameter_html_prefix=entry_point ~ '--', role_entrypoint=entry_point) }@
+@{ parameters_html(ep_doc['options'] | dictsort, suboption_key='options', role_entrypoint=entry_point) }@
{% endif %}
{% if ep_doc['attributes'] %}
diff --git a/src/sphinx_antsibull_ext/directive_helper.py b/src/sphinx_antsibull_ext/directive_helper.py
index 26523752..d02c828b 100644
--- a/src/sphinx_antsibull_ext/directive_helper.py
+++ b/src/sphinx_antsibull_ext/directive_helper.py
@@ -14,14 +14,16 @@
from antsibull_core.yaml import load_yaml_bytes
from docutils import nodes
-from docutils.parsers.rst import Directive
+from pydantic import BaseModel
+from pydantic.error_wrappers import ValidationError
+from sphinx.util.docutils import SphinxDirective
from antsibull_docs._pydantic_compat import v1
SchemaT = t.TypeVar("SchemaT", bound=v1.BaseModel)
-class YAMLDirective(Directive, t.Generic[SchemaT], metaclass=abc.ABCMeta):
+class YAMLDirective(SphinxDirective, t.Generic[SchemaT], metaclass=abc.ABCMeta):
has_content = True
wrap_as_data = False
diff --git a/src/sphinx_antsibull_ext/directives.py b/src/sphinx_antsibull_ext/directives.py
index 7a6bc702..f7a231dc 100644
--- a/src/sphinx_antsibull_ext/directives.py
+++ b/src/sphinx_antsibull_ext/directives.py
@@ -9,16 +9,38 @@
from __future__ import annotations
+import typing as t
+from urllib.parse import quote as _urllib_quote
+
from docutils import nodes
-from docutils.parsers.rst import Directive
-from sphinx import addnodes
+from docutils.nodes import Element
+from sphinx import addnodes, domains
+from sphinx.builders import Builder
+from sphinx.domains.std import StandardDomain
+from sphinx.environment import BuildEnvironment
+from sphinx.locale import _
+from sphinx.util import logging
+from sphinx.util.docutils import SphinxDirective
+from sphinx.util.nodes import make_id
+
+from antsibull_docs.utils.rst import massage_rst_label
from .directive_helper import YAMLDirective
-from .nodes import link_button
+from .nodes import ansible_attribute, ansible_option, ansible_return_value, link_button
from .schemas.ansible_links import AnsibleLinks
+from .schemas.ansible_plugin import (
+ AnsibleAttribute,
+ AnsibleOption,
+ AnsiblePlugin,
+ AnsibleRequirementsAnchor,
+ AnsibleReturnValue,
+ AnsibleRoleEntrypoint,
+)
+logger = logging.getLogger(__name__)
-class _OptionTypeLine(Directive):
+
+class _OptionTypeLine(SphinxDirective):
final_argument_whitespace = True
has_content = True
@@ -71,9 +93,352 @@ def _run(self, content_str: str, content: AnsibleLinks) -> list[nodes.Node]:
return [node]
+class AnsibleDomain(domains.Domain):
+ name = "ansible"
+
+ object_types: dict[str, domains.ObjType] = {
+ "plugin": domains.ObjType(_("plugin"), "plugin", searchprio=-1),
+ "role_entrypoint": domains.ObjType(
+ _("role entrypoint"), "role_entrypoint", searchprio=-1
+ ),
+ }
+
+ @property
+ def objects(self) -> dict[tuple[str, str], tuple[str, str]]:
+ return self.data.setdefault(
+ "objects", {}
+ ) # (objtype, name) -> docname, labelid
+
+ def note_object(
+ self, objtype: str, name: str, labelid: str, location: t.Any = None
+ ) -> None:
+ if (objtype, name) in self.objects:
+ docname = self.objects[objtype, name][0]
+ logger.warning(
+ f"Duplicate {objtype} description of {name}, other instance in {docname}",
+ location=location,
+ )
+ self.objects[objtype, name] = (self.env.docname, labelid)
+
+ def merge_domaindata(self, docnames: list[str], otherdata: dict) -> None:
+ """Merge in data regarding *docnames* from a different domaindata
+ inventory (coming from a subprocess in parallel builds).
+ """
+
+ def resolve_any_xref(
+ self,
+ env: BuildEnvironment,
+ fromdocname: str,
+ builder: Builder,
+ target: str,
+ node: addnodes.pending_xref,
+ contnode: Element,
+ ) -> list[tuple[str, Element]]:
+ """Resolve the pending_xref *node* with the given *target*."""
+ return []
+
+
+class _Plugin(YAMLDirective[AnsiblePlugin]):
+ schema = AnsiblePlugin
+
+ def _run(self, content_str: str, content: AnsiblePlugin) -> list[nodes.Node]:
+ section = self.state.parent
+ titles = [child for child in section.children if isinstance(child, nodes.title)]
+ if len(titles) != 1:
+ raise self.error(
+ f"Cannot find single title for section {section} - found {titles}"
+ )
+ title = titles[0]
+
+ if content.plugin_type == "role":
+ # just add index nodes for the entrypoints
+ return []
+
+ indexnode = addnodes.index(entries=[])
+ node_id = make_id(
+ self.env,
+ self.state.document,
+ "plugin",
+ f"{content.fqcn}_{content.plugin_type}",
+ )
+ title["ids"].append(node_id)
+ self.state.document.note_explicit_target(title)
+ index_category = content.plugin_type
+ if content.plugin_type not in ("role", "module"):
+ index_category = f"{index_category} plugin"
+ indexnode["entries"].append(
+ ("single", f"{index_category}; {content.fqcn}", node_id, "", None)
+ )
+ ansible = t.cast(AnsibleDomain, self.env.get_domain("ansible"))
+ ansible.note_object(
+ "plugin", f"{content.fqcn}_{content.plugin_type}", node_id, location=title
+ )
+
+ return [indexnode]
+
+
+class _RoleEntrypoint(YAMLDirective[AnsibleRoleEntrypoint]):
+ schema = AnsibleRoleEntrypoint
+
+ def _run(
+ self, content_str: str, content: AnsibleRoleEntrypoint
+ ) -> list[nodes.Node]:
+ section = self.state.parent
+ titles = [child for child in section.children if isinstance(child, nodes.title)]
+ if len(titles) != 1:
+ raise self.error(
+ f"Cannot find single title for section {section} - found {titles}"
+ )
+ title = titles[0]
+
+ indexnode = addnodes.index(entries=[])
+ node_id = make_id(
+ self.env,
+ self.state.document,
+ "role_entrypoint",
+ f"{content.fqcn}#{content.entrypoint}",
+ )
+ title["ids"].append(node_id)
+ self.state.document.note_explicit_target(title)
+ indexnode["entries"].append(
+ (
+ "single",
+ f"role; {content.fqcn}; {content.entrypoint} entrypoint",
+ node_id,
+ "",
+ None,
+ )
+ )
+ ansible = t.cast(AnsibleDomain, self.env.get_domain("ansible"))
+ ansible.note_object(
+ "role_entrypoint",
+ f"{content.fqcn}#{content.entrypoint}",
+ node_id,
+ location=title,
+ )
+
+ return [indexnode]
+
+
+def _plugin_name(fqcn: str, plugin_type: str) -> str:
+ if plugin_type in ("module", "role"):
+ return f"{fqcn} {plugin_type}"
+ return f"{fqcn} {plugin_type} plugin"
+
+
+class _RequirementsAnchor(YAMLDirective[AnsibleRequirementsAnchor]):
+ schema = AnsibleRequirementsAnchor
+
+ def _run(
+ self, content_str: str, content: AnsibleRequirementsAnchor
+ ) -> list[nodes.Node]:
+ section = self.state.parent
+ titles = [child for child in section.children if isinstance(child, nodes.title)]
+ if len(titles) != 1:
+ raise self.error(
+ f"Cannot find single title for section {section} - found {titles}"
+ )
+ title = titles[0]
+ self.state.document.note_explicit_target(title)
+ std = t.cast(StandardDomain, self.env.get_domain("std"))
+ rst_id = (
+ f"ansible_collections.{content.fqcn}_{content.plugin_type}_requirements"
+ )
+ plugin_name = _plugin_name(content.fqcn, content.plugin_type)
+ ref_title = f"Requirements of the {plugin_name}"
+ if content.role_entrypoint is not None and content.plugin_type == "role":
+ rst_id = (
+ f"ansible_collections.{content.fqcn}_role"
+ f"-{content.role_entrypoint}_requirements"
+ )
+ ref_title = f"{ref_title}, {content.role_entrypoint} entrypoint"
+ std.note_hyperlink_target(
+ rst_id,
+ self.env.docname,
+ title["ids"][0],
+ ref_title,
+ )
+ return []
+
+
+def _percent_encode(s):
+ return _urllib_quote(s, safe="")
+
+
+class _Attribute(YAMLDirective[AnsibleAttribute]):
+ schema = AnsibleAttribute
+
+ def _run(self, content_str: str, content: AnsibleAttribute) -> list[nodes.Node]:
+ html_id = f"attribute-{_percent_encode(content.name)}"
+ rst_id = (
+ f"ansible_collections.{content.fqcn}_{content.plugin_type}"
+ f"__attribute-{content.name}"
+ )
+ node = ansible_attribute(
+ "", content.name, classes=["ansible-option-title"], ids=[html_id]
+ )
+ plugin_name = _plugin_name(content.fqcn, content.plugin_type)
+ self.state.document.note_explicit_target(node)
+ std = t.cast(StandardDomain, self.env.get_domain("std"))
+ std.note_hyperlink_target(
+ rst_id,
+ self.env.docname,
+ html_id,
+ f"{content.name} attribute of {plugin_name}",
+ )
+ permalink = nodes.raw(
+ "",
+ f' ',
+ format="html",
+ )
+ return [node, permalink]
+
+
+def _make_unique(ids: list[str]) -> list[str]:
+ result = sorted(set(ids))
+ if ids:
+ result.remove(ids[0])
+ result.insert(0, ids[0])
+ return result
+
+
+def _compile_ids(
+ fqcn: str,
+ plugin_type: str,
+ role_entrypoint: str | None,
+ full_keys: list[list[str]],
+ prefix_type: str,
+) -> tuple[dict[str, tuple[str, str, str]], list[str]]:
+ rst_id_prefix = f"ansible_collections.{fqcn}_{plugin_type}__{prefix_type}-"
+ html_id_prefix = f"{prefix_type}-"
+ if role_entrypoint is not None:
+ rst_id_prefix += f"{role_entrypoint}__"
+ html_id_prefix += f"{role_entrypoint}--"
+ rst_ids = {}
+ html_ids = []
+ for full_key in full_keys:
+ html_id = html_id_prefix + "/".join([_percent_encode(k) for k in full_key])
+ rst_id = rst_id_prefix + "/".join([massage_rst_label(k) for k in full_key])
+ html_ids.append(html_id)
+ rst_ids[rst_id] = (html_id, ".".join(full_key), ".".join(full_key[1:]))
+ return rst_ids, _make_unique(html_ids)
+
+
+class _Option(YAMLDirective[AnsibleOption]):
+ schema = AnsibleOption
+
+ def _run(self, content_str: str, content: AnsibleOption) -> list[nodes.Node]:
+ rst_ids, html_ids = _compile_ids(
+ content.fqcn,
+ content.plugin_type,
+ content.role_entrypoint,
+ content.full_keys,
+ "parameter",
+ )
+ node = ansible_option(
+ "",
+ content.name,
+ classes=["ansible-option-title"],
+ ids=html_ids,
+ )
+ what_title = "{key} option of"
+ what_perma = "this option"
+ if content.plugin_type in ("lookup", "filter", "test"):
+ what_title = "{key} keyword option of"
+ what_perma = "this keyword option"
+ if content.special == "positional":
+ what_title = "{key} positional option of"
+ what_perma = "this positional option"
+ if content.special == "input":
+ what_title = "input of"
+ what_perma = f"the {content.plugin_type}'s input"
+ if len(content.full_keys[0]) > 1:
+ what_title = "nested input field {subkey} of"
+ what_perma = f"this nested field of the {content.plugin_type}'s input"
+ if content.special == "terms":
+ what_title = "terms for the"
+ what_perma = f"the {content.plugin_type}'s terms"
+ if len(content.full_keys[0]) > 1:
+ what_title = "nested term field {subkey} for the"
+ what_perma = f"this nested field of the {content.plugin_type}'s term"
+ plugin_name = _plugin_name(content.fqcn, content.plugin_type)
+ self.state.document.note_explicit_target(node)
+ std = t.cast(StandardDomain, self.env.get_domain("std"))
+ for rst_id, (html_id, key, subkey) in rst_ids.items():
+ rst_title = f"{what_title.format(key=key, subkey=subkey)} {plugin_name}"
+ std.note_hyperlink_target(
+ rst_id,
+ self.env.docname,
+ html_id,
+ rst_title,
+ )
+ permalink = nodes.raw(
+ "",
+ f' ',
+ format="html",
+ )
+ return [node, permalink]
+
+
+class _ReturnValue(YAMLDirective[AnsibleReturnValue]):
+ schema = AnsibleReturnValue
+
+ def _run(self, content_str: str, content: AnsibleReturnValue) -> list[nodes.Node]:
+ rst_ids, html_ids = _compile_ids(
+ content.fqcn,
+ content.plugin_type,
+ content.role_entrypoint,
+ content.full_keys,
+ "return",
+ )
+ node = ansible_return_value(
+ "",
+ content.name,
+ classes=["ansible-option-title"],
+ ids=html_ids,
+ )
+ what_title = "{key} return value of"
+ what_perma = "this return value"
+ if content.special == "facts":
+ what_title = "{key} returned fact of"
+ what_perma = "this returned fact"
+ if content.special == "return-value":
+ what_title = "return value of the"
+ what_perma = f"the {content.plugin_type}'s return value"
+ if len(content.full_keys[0]) > 1:
+ what_title = "nested return value field {subkey} of the"
+ what_perma = f"this nested return value of this {content.plugin_type}"
+ plugin_name = _plugin_name(content.fqcn, content.plugin_type)
+ self.state.document.note_explicit_target(node)
+ std = t.cast(StandardDomain, self.env.get_domain("std"))
+ for rst_id, (html_id, key, subkey) in rst_ids.items():
+ ref_title = f"{what_title.format(key=key, subkey=subkey)} {plugin_name}"
+ std.note_hyperlink_target(
+ rst_id,
+ self.env.docname,
+ html_id,
+ ref_title,
+ )
+ permalink = nodes.raw(
+ "",
+ f' ',
+ format="html",
+ )
+ return [node, permalink]
+
+
DIRECTIVES = {
"ansible-option-type-line": _OptionTypeLine,
"ansible-links": _Links,
+ "ansible-plugin": _Plugin,
+ "ansible-role-entrypoint": _RoleEntrypoint,
+ "ansible-requirements-anchor": _RequirementsAnchor,
+ "ansible-attribute": _Attribute,
+ "ansible-option": _Option,
+ "ansible-return-value": _ReturnValue,
}
@@ -81,5 +446,6 @@ def setup_directives(app):
"""
Setup directives for a Sphinx app object.
"""
+ app.add_domain(AnsibleDomain)
for name, directive in DIRECTIVES.items():
app.add_directive(name, directive)
diff --git a/src/sphinx_antsibull_ext/nodes.py b/src/sphinx_antsibull_ext/nodes.py
index 88836c91..5c57af61 100644
--- a/src/sphinx_antsibull_ext/nodes.py
+++ b/src/sphinx_antsibull_ext/nodes.py
@@ -19,6 +19,39 @@ def __init__(self, *args, link_external: bool = True, **kwargs):
self["link_external"] = link_external # pyre-ignore[16]
+class ansible_attribute(nodes.strong, nodes.Structural): # pyre-ignore[11]
+ def __init__(
+ self,
+ rawsource: str,
+ text: str,
+ *children: list[nodes.Node],
+ **attributes,
+ ):
+ nodes.strong.__init__(self, rawsource, text, *children, **attributes)
+
+
+class ansible_option(nodes.strong, nodes.Structural):
+ def __init__(
+ self,
+ rawsource: str,
+ text: str,
+ *children: list[nodes.Node],
+ **attributes,
+ ):
+ nodes.strong.__init__(self, rawsource, text, *children, **attributes)
+
+
+class ansible_return_value(nodes.strong, nodes.Structural):
+ def __init__(
+ self,
+ rawsource: str,
+ text: str,
+ *children: list[nodes.Node],
+ **attributes,
+ ):
+ nodes.strong.__init__(self, rawsource, text, *children, **attributes)
+
+
def visit_link_button_html(self, node) -> None:
atts = {
"class": "ansible-link reference",
@@ -43,3 +76,6 @@ def setup_nodes(app):
Setup nodes for a Sphinx app object.
"""
app.add_node(link_button, html=(visit_link_button_html, depart_link_button_html))
+ app.add_node(ansible_attribute)
+ app.add_node(ansible_option)
+ app.add_node(ansible_return_value)
diff --git a/src/sphinx_antsibull_ext/schemas/ansible_plugin.py b/src/sphinx_antsibull_ext/schemas/ansible_plugin.py
new file mode 100644
index 00000000..2f6a2cc2
--- /dev/null
+++ b/src/sphinx_antsibull_ext/schemas/ansible_plugin.py
@@ -0,0 +1,61 @@
+# Author: Felix Fontein
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or
+# https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+# SPDX-FileCopyrightText: 2023, Ansible Project
+"""Schema for ansible-plugin and ansible-role-entrypoint directives."""
+
+from __future__ import annotations
+
+import typing as t
+
+import pydantic as p
+
+# Ignore Unitialized attribute errors because BaseModel works some magic
+# to initialize the attributes when data is loaded into them.
+# pyre-ignore-all-errors[13]
+
+
+class AnsiblePlugin(p.BaseModel):
+ fqcn: str
+ plugin_type: str
+ short_description: t.Optional[str] = None
+
+
+class AnsibleRoleEntrypoint(p.BaseModel):
+ fqcn: str
+ entrypoint: str
+ short_description: t.Optional[str] = None
+
+
+class AnsibleRequirementsAnchor(p.BaseModel):
+ fqcn: str
+ plugin_type: str
+ role_entrypoint: t.Optional[str] = None
+
+
+class AnsibleAttribute(p.BaseModel):
+ fqcn: str
+ plugin_type: str
+ role_entrypoint: t.Optional[str] = None
+ name: str
+
+
+class AnsibleOption(p.BaseModel):
+ fqcn: str
+ plugin_type: str
+ role_entrypoint: t.Optional[str] = None
+ name: str
+ full_keys: list[list[str]]
+ special: t.Union[
+ t.Literal["positional"], t.Literal["input"], t.Literal["terms"], None
+ ] = None
+
+
+class AnsibleReturnValue(p.BaseModel):
+ fqcn: str
+ plugin_type: str
+ role_entrypoint: t.Optional[str] = None
+ name: str
+ full_keys: list[list[str]]
+ special: t.Union[t.Literal["facts"], t.Literal["return-value"], None] = None
diff --git a/tests/functional/baseline-default/collections/ns/col2/bar_role.rst b/tests/functional/baseline-default/collections/ns/col2/bar_role.rst
index fe8bf547..e0ebdd9d 100644
--- a/tests/functional/baseline-default/collections/ns/col2/bar_role.rst
+++ b/tests/functional/baseline-default/collections/ns/col2/bar_role.rst
@@ -18,6 +18,12 @@
ns.col2.bar role -- Bar role
++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns.col2.bar
+ plugin_type: role
+ short_description: "Bar role"
+
.. Collection note
.. note::
@@ -40,6 +46,12 @@ ns.col2.bar role -- Bar role
Entry point ``baz`` -- Bar role, baz entrypoint テストロール
------------------------------------------------------------
+.. ansible-role-entrypoint::
+
+ fqcn: ns.col2.bar
+ entrypoint: baz
+ short_description: "Bar role, baz entrypoint \u30c6\u30b9\u30c8\u30ed\u30fc\u30eb"
+
.. version_added
@@ -75,6 +87,12 @@ Synopsis
Entry point ``main`` -- Bar role
--------------------------------
+.. ansible-role-entrypoint::
+
+ fqcn: ns.col2.bar
+ entrypoint: main
+ short_description: "Bar role"
+
.. version_added
diff --git a/tests/functional/baseline-default/collections/ns/col2/foo2_module.rst b/tests/functional/baseline-default/collections/ns/col2/foo2_module.rst
index e8a646ec..83d3e6f1 100644
--- a/tests/functional/baseline-default/collections/ns/col2/foo2_module.rst
+++ b/tests/functional/baseline-default/collections/ns/col2/foo2_module.rst
@@ -20,6 +20,12 @@
ns.col2.foo2 module -- Foo two
++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ short_description: "Foo two"
+
.. Collection note
.. note::
@@ -62,10 +68,14 @@ Synopsis
.. Requirements
-.. _ansible_collections.ns.col2.foo2_module_requirements:
-
Requirements
------------
+
+.. ansible-requirements-anchor::
+
+ fqcn: ns.col2.foo2
+ plugin_type: module
+
The below requirements are needed on the host that executes this module.
- Foo.
@@ -94,17 +104,14 @@ Parameters
* - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo2_module__parameter-bar:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -130,17 +137,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo2_module__parameter-foo:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **foo**
-
- .. raw:: html
-
-
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["foo"]
.. ansible-option-type-line::
@@ -164,17 +168,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo2_module__parameter-subfoo:
-
- .. rst-class:: ansible-option-title
- **subfoo**
+ .. ansible-option::
- .. raw:: html
-
-
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ name: "subfoo"
+ full_keys:
+ - ["subfoo"]
.. ansible-option-type-line::
@@ -198,21 +199,18 @@ Parameters
* - .. raw:: html
-
.. raw:: latex
\hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
- .. _ansible_collections.ns.col2.foo2_module__parameter-subfoo/baz:
-
- .. rst-class:: ansible-option-title
-
- **BaZ**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ name: "BaZ"
+ full_keys:
+ - ["subfoo", "BaZ"]
.. ansible-option-type-line::
@@ -240,21 +238,18 @@ Parameters
* - .. raw:: html
-
.. raw:: latex
\hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
- .. _ansible_collections.ns.col2.foo2_module__parameter-subfoo/foo:
-
- .. rst-class:: ansible-option-title
-
- **foo**
+ .. ansible-option::
- .. raw:: html
-
-
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["subfoo", "foo"]
.. ansible-option-type-line::
@@ -308,17 +303,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo2_module__attribute-check_mode:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **check_mode**
-
- .. raw:: html
-
-
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ name: "check_mode"
.. raw:: html
@@ -350,17 +340,12 @@ Attributes
* - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo2_module__attribute-diff_mode:
+ .. ansible-attribute::
- .. rst-class:: ansible-option-title
-
- **diff_mode**
-
- .. raw:: html
-
-
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ name: "diff_mode"
.. raw:: html
@@ -392,17 +377,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo2_module__attribute-platform:
-
- .. rst-class:: ansible-option-title
-
- **platform**
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ name: "platform"
.. raw:: html
@@ -499,17 +479,14 @@ Common return values are documented :ref:`here `, the foll
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo2_module__return-bar:
-
- .. rst-class:: ansible-option-title
- **bar**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-default/collections/ns/col2/foo3_module.rst b/tests/functional/baseline-default/collections/ns/col2/foo3_module.rst
index cbb20ade..a6c28a01 100644
--- a/tests/functional/baseline-default/collections/ns/col2/foo3_module.rst
+++ b/tests/functional/baseline-default/collections/ns/col2/foo3_module.rst
@@ -20,6 +20,12 @@
ns.col2.foo3 module -- Foo III
++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns.col2.foo3
+ plugin_type: module
+ short_description: "Foo III"
+
.. Collection note
.. note::
@@ -57,10 +63,14 @@ Synopsis
.. Requirements
-.. _ansible_collections.ns.col2.foo3_module_requirements:
-
Requirements
------------
+
+.. ansible-requirements-anchor::
+
+ fqcn: ns.col2.foo3
+ plugin_type: module
+
The below requirements are needed on the host that executes this module.
- Foo.
@@ -89,17 +99,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo3_module__parameter-bar:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns.col2.foo3
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -123,17 +130,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo3_module__parameter-foo:
-
- .. rst-class:: ansible-option-title
-
- **foo**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns.col2.foo3
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["foo"]
.. ansible-option-type-line::
@@ -157,17 +161,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo3_module__parameter-subfoo:
-
- .. rst-class:: ansible-option-title
-
- **subfoo**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns.col2.foo3
+ plugin_type: module
+ name: "subfoo"
+ full_keys:
+ - ["subfoo"]
.. ansible-option-type-line::
@@ -191,21 +192,18 @@ Parameters
* - .. raw:: html
-
.. raw:: latex
\hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
- .. _ansible_collections.ns.col2.foo3_module__parameter-subfoo/foo:
-
- .. rst-class:: ansible-option-title
-
- **foo**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns.col2.foo3
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["subfoo", "foo"]
.. ansible-option-type-line::
@@ -257,17 +255,12 @@ Attributes
* - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo3_module__attribute-check_mode:
-
- .. rst-class:: ansible-option-title
-
- **check_mode**
-
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns.col2.foo3
+ plugin_type: module
+ name: "check_mode"
.. raw:: html
@@ -299,17 +292,12 @@ Attributes
* - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo3_module__attribute-diff_mode:
+ .. ansible-attribute::
- .. rst-class:: ansible-option-title
-
- **diff_mode**
-
- .. raw:: html
-
-
+ fqcn: ns.col2.foo3
+ plugin_type: module
+ name: "diff_mode"
.. raw:: html
@@ -341,17 +329,12 @@ Attributes
* - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo3_module__attribute-platform:
-
- .. rst-class:: ansible-option-title
-
- **platform**
-
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns.col2.foo3
+ plugin_type: module
+ name: "platform"
.. raw:: html
diff --git a/tests/functional/baseline-default/collections/ns/col2/foo4_module.rst b/tests/functional/baseline-default/collections/ns/col2/foo4_module.rst
index b7568c0f..4a062d2c 100644
--- a/tests/functional/baseline-default/collections/ns/col2/foo4_module.rst
+++ b/tests/functional/baseline-default/collections/ns/col2/foo4_module.rst
@@ -20,6 +20,12 @@
ns.col2.foo4 module -- Markup reference linting test
++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns.col2.foo4
+ plugin_type: module
+ short_description: "Markup reference linting test"
+
.. Collection note
.. note::
@@ -78,17 +84,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo4_module__parameter-correct_array_stubs:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **correct_array_stubs**
-
- .. raw:: html
-
-
+ fqcn: ns.col2.foo4
+ plugin_type: module
+ name: "correct_array_stubs"
+ full_keys:
+ - ["correct_array_stubs"]
.. ansible-option-type-line::
@@ -124,17 +127,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo4_module__parameter-existing:
-
- .. rst-class:: ansible-option-title
-
- **existing**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns.col2.foo4
+ plugin_type: module
+ name: "existing"
+ full_keys:
+ - ["existing"]
.. ansible-option-type-line::
@@ -198,17 +198,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo4_module__parameter-incorrect_array_stubs:
-
- .. rst-class:: ansible-option-title
- **incorrect_array_stubs**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns.col2.foo4
+ plugin_type: module
+ name: "incorrect_array_stubs"
+ full_keys:
+ - ["incorrect_array_stubs"]
.. ansible-option-type-line::
@@ -242,17 +239,14 @@ Parameters
* - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo4_module__parameter-not_existing:
-
- .. rst-class:: ansible-option-title
-
- **not_existing**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns.col2.foo4
+ plugin_type: module
+ name: "not_existing"
+ full_keys:
+ - ["not_existing"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-default/collections/ns/col2/foo_module.rst b/tests/functional/baseline-default/collections/ns/col2/foo_module.rst
index 2a29132a..b65ba778 100644
--- a/tests/functional/baseline-default/collections/ns/col2/foo_module.rst
+++ b/tests/functional/baseline-default/collections/ns/col2/foo_module.rst
@@ -17,6 +17,10 @@
ns.col2.foo module
++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns.col2.foo
+ plugin_type: module
The documentation for the module plugin, ns.col2.foo, was malformed.
diff --git a/tests/functional/baseline-default/collections/ns2/col/bar_filter.rst b/tests/functional/baseline-default/collections/ns2/col/bar_filter.rst
index 02bd2e03..02c0f5dd 100644
--- a/tests/functional/baseline-default/collections/ns2/col/bar_filter.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/bar_filter.rst
@@ -21,6 +21,12 @@
ns2.col.bar filter -- The bar filter
++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.bar
+ plugin_type: filter
+ short_description: "The bar filter"
+
.. Collection note
.. note::
@@ -84,17 +90,15 @@ This describes the input of the filter, the value before ``| ns2.col.bar``.
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.bar_filter__parameter-_input:
- .. rst-class:: ansible-option-title
-
- **Input**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.bar
+ plugin_type: filter
+ name: "Input"
+ full_keys:
+ - ["_input"]
+ special: input
.. ansible-option-type-line::
@@ -143,17 +147,15 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)``
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.bar_filter__parameter-foo:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **foo**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.bar
+ plugin_type: filter
+ name: "foo"
+ full_keys:
+ - ["foo"]
+ special: positional
.. ansible-option-type-line::
@@ -180,17 +182,15 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)``
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.bar_filter__parameter-bar:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.bar
+ plugin_type: filter
+ name: "bar"
+ full_keys:
+ - ["bar"]
+ special: positional
.. ansible-option-type-line::
@@ -246,17 +246,14 @@ example: ``input | ns2.col.bar(key1=value1, key2=value2, ...)``
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.bar_filter__parameter-baz:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **baz**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.bar
+ plugin_type: filter
+ name: "baz"
+ full_keys:
+ - ["baz"]
.. ansible-option-type-line::
@@ -351,17 +348,15 @@ Return Value
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.bar_filter__return-_value:
-
- .. rst-class:: ansible-option-title
- **Return value**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.bar
+ plugin_type: filter
+ name: "Return value"
+ full_keys:
+ - ["_value"]
+ special: return-value
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-default/collections/ns2/col/bar_test.rst b/tests/functional/baseline-default/collections/ns2/col/bar_test.rst
index 7f09cc31..5b6d4b71 100644
--- a/tests/functional/baseline-default/collections/ns2/col/bar_test.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/bar_test.rst
@@ -21,6 +21,12 @@
ns2.col.bar test -- Is something a bar
++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.bar
+ plugin_type: test
+ short_description: "Is something a bar"
+
.. Collection note
.. note::
@@ -82,17 +88,15 @@ This describes the input of the test, the value before ``is ns2.col.bar`` or ``i
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.bar_test__parameter-_input:
-
- .. rst-class:: ansible-option-title
-
- **Input**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.bar
+ plugin_type: test
+ name: "Input"
+ full_keys:
+ - ["_input"]
+ special: input
.. ansible-option-type-line::
@@ -165,17 +169,15 @@ Return Value
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.bar_test__return-_value:
-
- .. rst-class:: ansible-option-title
- **Return value**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.bar
+ plugin_type: test
+ name: "Return value"
+ full_keys:
+ - ["_value"]
+ special: return-value
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo2_module.rst b/tests/functional/baseline-default/collections/ns2/col/foo2_module.rst
index 62ba96ab..27ace73c 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo2_module.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo2_module.rst
@@ -21,6 +21,12 @@
ns2.col.foo2 module -- Another foo
++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ short_description: "Another foo"
+
.. Collection note
.. note::
@@ -82,17 +88,14 @@ Parameters
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo2_module__parameter-bar:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -137,17 +140,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo2_module__attribute-action_group:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **action_group**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ name: "action_group"
.. raw:: html
@@ -179,17 +177,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo2_module__attribute-check_mode:
-
- .. rst-class:: ansible-option-title
-
- **check_mode**
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ name: "check_mode"
.. raw:: html
@@ -221,17 +214,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo2_module__attribute-diff_mode:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **diff_mode**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ name: "diff_mode"
.. raw:: html
@@ -263,17 +251,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo2_module__attribute-platform:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **platform**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ name: "platform"
.. raw:: html
@@ -347,17 +330,14 @@ Common return values are documented :ref:`here `, the foll
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo2_module__return-bar:
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_become.rst b/tests/functional/baseline-default/collections/ns2/col/foo_become.rst
index a2e2948f..ffe66ca2 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_become.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_become.rst
@@ -21,6 +21,12 @@
ns2.col.foo become -- Use foo \ :ansopt:`ns2.col.foo#become:bar`\
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: become
+ short_description: "Use foo \\ :ansopt:`ns2.col.foo#become:bar`\\ "
+
.. Collection note
.. note::
@@ -92,17 +98,14 @@ Parameters
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_become__parameter-bar:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: become
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -149,17 +152,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_become__parameter-become_exe:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **become_exe**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: become
+ name: "become_exe"
+ full_keys:
+ - ["become_exe"]
.. ansible-option-type-line::
@@ -244,17 +244,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_become__parameter-become_user:
- .. rst-class:: ansible-option-title
-
- **become_user**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: become
+ name: "become_user"
+ full_keys:
+ - ["become_user"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_cache.rst b/tests/functional/baseline-default/collections/ns2/col/foo_cache.rst
index 539a4ae9..84e75e86 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_cache.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_cache.rst
@@ -21,6 +21,12 @@
ns2.col.foo cache -- Foo files \ :ansopt:`ns2.col.foo#cache:bar`\
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: cache
+ short_description: "Foo files \\ :ansopt:`ns2.col.foo#cache:bar`\\ "
+
.. Collection note
.. note::
@@ -83,17 +89,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_cache__parameter-_uri:
-
- .. rst-class:: ansible-option-title
-
- **_uri**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: cache
+ name: "_uri"
+ full_keys:
+ - ["_uri"]
.. ansible-option-type-line::
@@ -135,17 +138,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_cache__parameter-bar:
-
- .. rst-class:: ansible-option-title
- **bar**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: cache
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_callback.rst b/tests/functional/baseline-default/collections/ns2/col/foo_callback.rst
index 9a277b2c..18e43008 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_callback.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_callback.rst
@@ -21,6 +21,12 @@
ns2.col.foo callback -- Foo output \ :ansopt:`ns2.col.foo#callback:bar`\
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: callback
+ short_description: "Foo output \\ :ansopt:`ns2.col.foo#callback:bar`\\ "
+
.. Collection note
.. note::
@@ -89,17 +95,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_callback__parameter-bar:
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: callback
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_cliconf.rst b/tests/functional/baseline-default/collections/ns2/col/foo_cliconf.rst
index b570e0a4..78a95549 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_cliconf.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_cliconf.rst
@@ -21,6 +21,12 @@
ns2.col.foo cliconf -- Foo router CLI config
++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: cliconf
+ short_description: "Foo router CLI config"
+
.. Collection note
.. note::
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_connection.rst b/tests/functional/baseline-default/collections/ns2/col/foo_connection.rst
index 84d69342..821a5ef5 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_connection.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_connection.rst
@@ -21,6 +21,12 @@
ns2.col.foo connection -- Foo connection \ :ansopt:`ns2.col.foo#connection:bar`\
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: connection
+ short_description: "Foo connection \\ :ansopt:`ns2.col.foo#connection:bar`\\ "
+
.. Collection note
.. note::
@@ -83,17 +89,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_connection__parameter-bar:
-
- .. rst-class:: ansible-option-title
-
- **bar**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: connection
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -120,17 +123,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_connection__parameter-host:
-
- .. rst-class:: ansible-option-title
- **host**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: connection
+ name: "host"
+ full_keys:
+ - ["host"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_filter.rst b/tests/functional/baseline-default/collections/ns2/col/foo_filter.rst
index aafe1534..1e13419a 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_filter.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_filter.rst
@@ -21,6 +21,12 @@
ns2.col.foo filter -- The foo filter \ :ansopt:`ns2.col.foo#filter:bar`\
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: filter
+ short_description: "The foo filter \\ :ansopt:`ns2.col.foo#filter:bar`\\ "
+
.. Collection note
.. note::
@@ -84,17 +90,15 @@ This describes the input of the filter, the value before ``| ns2.col.foo``.
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_filter__parameter-_input:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **Input**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: filter
+ name: "Input"
+ full_keys:
+ - ["_input"]
+ special: input
.. ansible-option-type-line::
@@ -143,17 +147,14 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_filter__parameter-bar:
-
- .. rst-class:: ansible-option-title
-
- **bar**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: filter
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -180,17 +181,14 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_filter__parameter-foo:
-
- .. rst-class:: ansible-option-title
- **foo**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: filter
+ name: "foo"
+ full_keys:
+ - ["foo"]
.. ansible-option-type-line::
@@ -259,17 +257,15 @@ Return Value
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_filter__return-_value:
-
- .. rst-class:: ansible-option-title
-
- **Return value**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.foo
+ plugin_type: filter
+ name: "Return value"
+ full_keys:
+ - ["_value"]
+ special: return-value
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_inventory.rst b/tests/functional/baseline-default/collections/ns2/col/foo_inventory.rst
index abce5ac6..f7256178 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_inventory.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_inventory.rst
@@ -21,6 +21,12 @@
ns2.col.foo inventory -- The foo inventory \ :ansopt:`ns2.col.foo#inventory:bar`\
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: inventory
+ short_description: "The foo inventory \\ :ansopt:`ns2.col.foo#inventory:bar`\\ "
+
.. Collection note
.. note::
@@ -83,17 +89,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_inventory__parameter-bar:
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: inventory
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_lookup.rst b/tests/functional/baseline-default/collections/ns2/col/foo_lookup.rst
index f4e53de0..39baa675 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_lookup.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_lookup.rst
@@ -21,6 +21,12 @@
ns2.col.foo lookup -- Look up some foo \ :ansopt:`ns2.col.foo#lookup:bar`\
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: lookup
+ short_description: "Look up some foo \\ :ansopt:`ns2.col.foo#lookup:bar`\\ "
+
.. Collection note
.. note::
@@ -82,17 +88,15 @@ Terms
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_lookup__parameter-_terms:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **Terms**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: lookup
+ name: "Terms"
+ full_keys:
+ - ["_terms"]
+ special: terms
.. ansible-option-type-line::
@@ -142,17 +146,14 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query('
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_lookup__parameter-bar:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: lookup
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -229,17 +230,15 @@ Return Value
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_lookup__return-_raw:
- .. rst-class:: ansible-option-title
-
- **Return value**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.foo
+ plugin_type: lookup
+ name: "Return value"
+ full_keys:
+ - ["_raw"]
+ special: return-value
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_module.rst b/tests/functional/baseline-default/collections/ns2/col/foo_module.rst
index 1f14bfe6..c47f1926 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_module.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_module.rst
@@ -21,6 +21,12 @@
ns2.col.foo module -- Do some foo \ :ansopt:`ns2.col.foo#module:bar`\
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: module
+ short_description: "Do some foo \\ :ansopt:`ns2.col.foo#module:bar`\\ "
+
.. Collection note
.. note::
@@ -64,10 +70,14 @@ Aliases: foo_redirect
.. Requirements
-.. _ansible_collections.ns2.col.foo_module_requirements:
-
Requirements
------------
+
+.. ansible-requirements-anchor::
+
+ fqcn: ns2.col.foo
+ plugin_type: module
+
The below requirements are needed on the host that executes this module.
- Foo on remote.
@@ -96,19 +106,15 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__parameter-bar:
- .. _ansible_collections.ns2.col.foo_module__parameter-baz:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
+ - ["baz"]
.. ansible-option-type-line::
@@ -138,17 +144,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__parameter-foo:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **foo**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["foo"]
.. ansible-option-type-line::
@@ -172,17 +175,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__parameter-subfoo:
-
- .. rst-class:: ansible-option-title
- **subfoo**
+ .. ansible-option::
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "subfoo"
+ full_keys:
+ - ["subfoo"]
.. ansible-option-type-line::
@@ -209,21 +209,18 @@ Parameters
* - .. raw:: html
-
.. raw:: latex
\hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
- .. _ansible_collections.ns2.col.foo_module__parameter-subfoo/foo:
-
- .. rst-class:: ansible-option-title
-
- **foo**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["subfoo", "foo"]
.. ansible-option-type-line::
@@ -275,17 +272,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__attribute-action_group:
-
- .. rst-class:: ansible-option-title
- **action_group**
+ .. ansible-attribute::
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "action_group"
.. raw:: html
@@ -317,17 +309,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__attribute-check_mode:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **check_mode**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "check_mode"
.. raw:: html
@@ -359,17 +346,12 @@ Attributes
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_module__attribute-diff_mode:
+ .. ansible-attribute::
- .. rst-class:: ansible-option-title
-
- **diff_mode**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "diff_mode"
.. raw:: html
@@ -401,17 +383,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__attribute-platform:
-
- .. rst-class:: ansible-option-title
-
- **platform**
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "platform"
.. raw:: html
@@ -504,17 +481,14 @@ Common return values are documented :ref:`here `, the foll
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__return-bar:
-
- .. rst-class:: ansible-option-title
- **bar**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_redirect_module.rst b/tests/functional/baseline-default/collections/ns2/col/foo_redirect_module.rst
index 2b01a6c0..10b231f5 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_redirect_module.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_redirect_module.rst
@@ -15,6 +15,11 @@
ns2.col.foo_redirect module
+++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo_redirect
+ plugin_type: module
+
.. Collection note
.. note::
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_role.rst b/tests/functional/baseline-default/collections/ns2/col/foo_role.rst
index dd66290c..205b6000 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_role.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_role.rst
@@ -19,6 +19,12 @@
ns2.col.foo role -- Foo role
++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: role
+ short_description: "Foo role"
+
.. Collection note
.. note::
@@ -41,6 +47,12 @@ ns2.col.foo role -- Foo role
Entry point ``main`` -- Foo role
--------------------------------
+.. ansible-role-entrypoint::
+
+ fqcn: ns2.col.foo
+ entrypoint: main
+ short_description: "Foo role"
+
.. version_added
.. rst-class:: ansible-version-added
@@ -91,17 +103,15 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_role__parameter-main__foo_param_1:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **foo_param_1**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: role
+ role_entrypoint: "main"
+ name: "foo_param_1"
+ full_keys:
+ - ["foo_param_1"]
.. ansible-option-type-line::
@@ -130,17 +140,15 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_role__parameter-main__foo_param_2:
-
- .. rst-class:: ansible-option-title
- **foo_param_2**
+ .. ansible-option::
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: role
+ role_entrypoint: "main"
+ name: "foo_param_2"
+ full_keys:
+ - ["foo_param_2"]
.. ansible-option-type-line::
@@ -190,17 +198,13 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_role__attribute-main__check_mode:
-
- .. rst-class:: ansible-option-title
-
- **check_mode**
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns2.col.foo
+ plugin_type: role
+ role_entrypoint: "main"
+ name: "check_mode"
.. raw:: html
@@ -232,17 +236,13 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_role__attribute-main__platform:
-
- .. rst-class:: ansible-option-title
- **platform**
-
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns2.col.foo
+ plugin_type: role
+ role_entrypoint: "main"
+ name: "platform"
.. raw:: html
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_shell.rst b/tests/functional/baseline-default/collections/ns2/col/foo_shell.rst
index b021c328..5e0dccf9 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_shell.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_shell.rst
@@ -21,6 +21,12 @@
ns2.col.foo shell -- Foo shell \ :ansopt:`ns2.col.foo#shell:bar`\
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: shell
+ short_description: "Foo shell \\ :ansopt:`ns2.col.foo#shell:bar`\\ "
+
.. Collection note
.. note::
@@ -83,17 +89,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_shell__parameter-bar:
-
- .. rst-class:: ansible-option-title
-
- **bar**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: shell
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -120,17 +123,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_shell__parameter-remote_tmp:
-
- .. rst-class:: ansible-option-title
- **remote_tmp**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: shell
+ name: "remote_tmp"
+ full_keys:
+ - ["remote_tmp"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_strategy.rst b/tests/functional/baseline-default/collections/ns2/col/foo_strategy.rst
index 8d8b164e..71f93dda 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_strategy.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_strategy.rst
@@ -21,6 +21,12 @@
ns2.col.foo strategy -- Executes tasks in foo
+++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: strategy
+ short_description: "Executes tasks in foo"
+
.. Collection note
.. note::
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_test.rst b/tests/functional/baseline-default/collections/ns2/col/foo_test.rst
index b369f125..9bec8320 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_test.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_test.rst
@@ -21,6 +21,12 @@
ns2.col.foo test -- Is something a foo \ :ansopt:`ns2.col.foo#test:bar`\
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: test
+ short_description: "Is something a foo \\ :ansopt:`ns2.col.foo#test:bar`\\ "
+
.. Collection note
.. note::
@@ -81,17 +87,15 @@ This describes the input of the test, the value before ``is ns2.col.foo`` or ``i
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_test__parameter-_input:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **Input**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: test
+ name: "Input"
+ full_keys:
+ - ["_input"]
+ special: input
.. ansible-option-type-line::
@@ -140,17 +144,14 @@ examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_test__parameter-bar:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: test
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -219,17 +220,15 @@ Return Value
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_test__return-_value:
- .. rst-class:: ansible-option-title
-
- **Return value**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.foo
+ plugin_type: test
+ name: "Return value"
+ full_keys:
+ - ["_value"]
+ special: return-value
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-default/collections/ns2/col/foo_vars.rst b/tests/functional/baseline-default/collections/ns2/col/foo_vars.rst
index f460e625..943dfc7b 100644
--- a/tests/functional/baseline-default/collections/ns2/col/foo_vars.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/foo_vars.rst
@@ -21,6 +21,12 @@
ns2.col.foo vars -- Load foo \ :ansopt:`ns2.col.foo#vars:bar`\
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: vars
+ short_description: "Load foo \\ :ansopt:`ns2.col.foo#vars:bar`\\ "
+
.. Collection note
.. note::
@@ -62,10 +68,14 @@ Synopsis
.. Requirements
-.. _ansible_collections.ns2.col.foo_vars_requirements:
-
Requirements
------------
+
+.. ansible-requirements-anchor::
+
+ fqcn: ns2.col.foo
+ plugin_type: vars
+
The below requirements are needed on the local controller node that executes this vars.
- Enabled in Ansible's configuration.
@@ -94,17 +104,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_vars__parameter-_valid_extensions:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **_valid_extensions**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: vars
+ name: "_valid_extensions"
+ full_keys:
+ - ["_valid_extensions"]
.. ansible-option-type-line::
@@ -150,17 +157,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_vars__parameter-bar:
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: vars
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-default/collections/ns2/col/is_bar_test.rst b/tests/functional/baseline-default/collections/ns2/col/is_bar_test.rst
index 86dbccab..21ce1a6c 100644
--- a/tests/functional/baseline-default/collections/ns2/col/is_bar_test.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/is_bar_test.rst
@@ -15,6 +15,11 @@
ns2.col.is_bar test
+++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.is_bar
+ plugin_type: test
+
.. Collection note
.. note::
diff --git a/tests/functional/baseline-default/collections/ns2/col/sub.foo3_module.rst b/tests/functional/baseline-default/collections/ns2/col/sub.foo3_module.rst
index b55705df..f01c5e54 100644
--- a/tests/functional/baseline-default/collections/ns2/col/sub.foo3_module.rst
+++ b/tests/functional/baseline-default/collections/ns2/col/sub.foo3_module.rst
@@ -21,6 +21,12 @@
ns2.col.sub.foo3 module -- A sub-foo
++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ short_description: "A sub-foo"
+
.. Collection note
.. note::
@@ -81,17 +87,14 @@ Parameters
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.sub.foo3_module__parameter-bar:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -136,17 +139,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.sub.foo3_module__attribute-action_group:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **action_group**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ name: "action_group"
.. raw:: html
@@ -178,17 +176,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.sub.foo3_module__attribute-check_mode:
-
- .. rst-class:: ansible-option-title
-
- **check_mode**
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ name: "check_mode"
.. raw:: html
@@ -220,17 +213,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.sub.foo3_module__attribute-diff_mode:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **diff_mode**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ name: "diff_mode"
.. raw:: html
@@ -262,17 +250,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.sub.foo3_module__attribute-platform:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **platform**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ name: "platform"
.. raw:: html
@@ -346,17 +329,14 @@ Common return values are documented :ref:`here `, the foll
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.sub.foo3_module__return-bar:
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-default/collections/ns2/flatcol/foo2_module.rst b/tests/functional/baseline-default/collections/ns2/flatcol/foo2_module.rst
index 4d2793e5..22ccc905 100644
--- a/tests/functional/baseline-default/collections/ns2/flatcol/foo2_module.rst
+++ b/tests/functional/baseline-default/collections/ns2/flatcol/foo2_module.rst
@@ -20,6 +20,12 @@
ns2.flatcol.foo2 module -- Another foo
++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.flatcol.foo2
+ plugin_type: module
+ short_description: "Another foo"
+
.. Collection note
.. note::
@@ -80,17 +86,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.flatcol.foo2_module__parameter-bar:
-
- .. rst-class:: ansible-option-title
-
- **bar**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.flatcol.foo2
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -161,17 +164,14 @@ Common return values are documented :ref:`here `, the foll
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.flatcol.foo2_module__return-bar:
-
- .. rst-class:: ansible-option-title
- **bar**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.flatcol.foo2
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-default/collections/ns2/flatcol/foo_module.rst b/tests/functional/baseline-default/collections/ns2/flatcol/foo_module.rst
index 427b32f3..0542d34a 100644
--- a/tests/functional/baseline-default/collections/ns2/flatcol/foo_module.rst
+++ b/tests/functional/baseline-default/collections/ns2/flatcol/foo_module.rst
@@ -20,6 +20,12 @@
ns2.flatcol.foo module -- Do some foo \ :ansopt:`ns2.flatcol.foo#module:bar`\
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.flatcol.foo
+ plugin_type: module
+ short_description: "Do some foo \\ :ansopt:`ns2.flatcol.foo#module:bar`\\ "
+
.. Collection note
.. note::
@@ -83,19 +89,15 @@ Parameters
* - .. raw:: html
-
-
-
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-bar:
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-baz:
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.flatcol.foo
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
+ - ["baz"]
.. ansible-option-type-line::
@@ -125,17 +127,14 @@ Parameters
* - .. raw:: html
-
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-foo:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **foo**
-
- .. raw:: html
-
-
+ fqcn: ns2.flatcol.foo
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["foo"]
.. ansible-option-type-line::
@@ -159,19 +158,15 @@ Parameters
* - .. raw:: html
-
-
-
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-subbaz:
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-subfoo:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **subfoo**
-
- .. raw:: html
-
-
+ fqcn: ns2.flatcol.foo
+ plugin_type: module
+ name: "subfoo"
+ full_keys:
+ - ["subfoo"]
+ - ["subbaz"]
.. ansible-option-type-line::
@@ -200,27 +195,21 @@ Parameters
* - .. raw:: html
-
-
-
-
.. raw:: latex
\hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-subbaz/bam:
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-subbaz/foo:
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-subfoo/bam:
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-subfoo/foo:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **foo**
-
- .. raw:: html
-
-
+ fqcn: ns2.flatcol.foo
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["subfoo", "foo"]
+ - ["subbaz", "foo"]
+ - ["subfoo", "bam"]
+ - ["subbaz", "bam"]
.. ansible-option-type-line::
@@ -310,17 +299,14 @@ Common return values are documented :ref:`here `, the foll
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.flatcol.foo_module__return-bar:
-
- .. rst-class:: ansible-option-title
- **bar**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.flatcol.foo
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/bar_role.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/bar_role.rst
index fe8bf547..e0ebdd9d 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/bar_role.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/bar_role.rst
@@ -18,6 +18,12 @@
ns.col2.bar role -- Bar role
++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns.col2.bar
+ plugin_type: role
+ short_description: "Bar role"
+
.. Collection note
.. note::
@@ -40,6 +46,12 @@ ns.col2.bar role -- Bar role
Entry point ``baz`` -- Bar role, baz entrypoint テストロール
------------------------------------------------------------
+.. ansible-role-entrypoint::
+
+ fqcn: ns.col2.bar
+ entrypoint: baz
+ short_description: "Bar role, baz entrypoint \u30c6\u30b9\u30c8\u30ed\u30fc\u30eb"
+
.. version_added
@@ -75,6 +87,12 @@ Synopsis
Entry point ``main`` -- Bar role
--------------------------------
+.. ansible-role-entrypoint::
+
+ fqcn: ns.col2.bar
+ entrypoint: main
+ short_description: "Bar role"
+
.. version_added
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/foo2_module.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/foo2_module.rst
index e8a646ec..83d3e6f1 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/foo2_module.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/foo2_module.rst
@@ -20,6 +20,12 @@
ns.col2.foo2 module -- Foo two
++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ short_description: "Foo two"
+
.. Collection note
.. note::
@@ -62,10 +68,14 @@ Synopsis
.. Requirements
-.. _ansible_collections.ns.col2.foo2_module_requirements:
-
Requirements
------------
+
+.. ansible-requirements-anchor::
+
+ fqcn: ns.col2.foo2
+ plugin_type: module
+
The below requirements are needed on the host that executes this module.
- Foo.
@@ -94,17 +104,14 @@ Parameters
* - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo2_module__parameter-bar:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -130,17 +137,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo2_module__parameter-foo:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **foo**
-
- .. raw:: html
-
-
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["foo"]
.. ansible-option-type-line::
@@ -164,17 +168,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo2_module__parameter-subfoo:
-
- .. rst-class:: ansible-option-title
- **subfoo**
+ .. ansible-option::
- .. raw:: html
-
-
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ name: "subfoo"
+ full_keys:
+ - ["subfoo"]
.. ansible-option-type-line::
@@ -198,21 +199,18 @@ Parameters
* - .. raw:: html
-
.. raw:: latex
\hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
- .. _ansible_collections.ns.col2.foo2_module__parameter-subfoo/baz:
-
- .. rst-class:: ansible-option-title
-
- **BaZ**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ name: "BaZ"
+ full_keys:
+ - ["subfoo", "BaZ"]
.. ansible-option-type-line::
@@ -240,21 +238,18 @@ Parameters
* - .. raw:: html
-
.. raw:: latex
\hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
- .. _ansible_collections.ns.col2.foo2_module__parameter-subfoo/foo:
-
- .. rst-class:: ansible-option-title
-
- **foo**
+ .. ansible-option::
- .. raw:: html
-
-
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["subfoo", "foo"]
.. ansible-option-type-line::
@@ -308,17 +303,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo2_module__attribute-check_mode:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **check_mode**
-
- .. raw:: html
-
-
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ name: "check_mode"
.. raw:: html
@@ -350,17 +340,12 @@ Attributes
* - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo2_module__attribute-diff_mode:
+ .. ansible-attribute::
- .. rst-class:: ansible-option-title
-
- **diff_mode**
-
- .. raw:: html
-
-
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ name: "diff_mode"
.. raw:: html
@@ -392,17 +377,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo2_module__attribute-platform:
-
- .. rst-class:: ansible-option-title
-
- **platform**
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ name: "platform"
.. raw:: html
@@ -499,17 +479,14 @@ Common return values are documented :ref:`here `, the foll
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo2_module__return-bar:
-
- .. rst-class:: ansible-option-title
- **bar**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns.col2.foo2
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/foo3_module.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/foo3_module.rst
index cbb20ade..a6c28a01 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/foo3_module.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/foo3_module.rst
@@ -20,6 +20,12 @@
ns.col2.foo3 module -- Foo III
++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns.col2.foo3
+ plugin_type: module
+ short_description: "Foo III"
+
.. Collection note
.. note::
@@ -57,10 +63,14 @@ Synopsis
.. Requirements
-.. _ansible_collections.ns.col2.foo3_module_requirements:
-
Requirements
------------
+
+.. ansible-requirements-anchor::
+
+ fqcn: ns.col2.foo3
+ plugin_type: module
+
The below requirements are needed on the host that executes this module.
- Foo.
@@ -89,17 +99,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo3_module__parameter-bar:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns.col2.foo3
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -123,17 +130,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo3_module__parameter-foo:
-
- .. rst-class:: ansible-option-title
-
- **foo**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns.col2.foo3
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["foo"]
.. ansible-option-type-line::
@@ -157,17 +161,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo3_module__parameter-subfoo:
-
- .. rst-class:: ansible-option-title
-
- **subfoo**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns.col2.foo3
+ plugin_type: module
+ name: "subfoo"
+ full_keys:
+ - ["subfoo"]
.. ansible-option-type-line::
@@ -191,21 +192,18 @@ Parameters
* - .. raw:: html
-
.. raw:: latex
\hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
- .. _ansible_collections.ns.col2.foo3_module__parameter-subfoo/foo:
-
- .. rst-class:: ansible-option-title
-
- **foo**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns.col2.foo3
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["subfoo", "foo"]
.. ansible-option-type-line::
@@ -257,17 +255,12 @@ Attributes
* - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo3_module__attribute-check_mode:
-
- .. rst-class:: ansible-option-title
-
- **check_mode**
-
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns.col2.foo3
+ plugin_type: module
+ name: "check_mode"
.. raw:: html
@@ -299,17 +292,12 @@ Attributes
* - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo3_module__attribute-diff_mode:
+ .. ansible-attribute::
- .. rst-class:: ansible-option-title
-
- **diff_mode**
-
- .. raw:: html
-
-
+ fqcn: ns.col2.foo3
+ plugin_type: module
+ name: "diff_mode"
.. raw:: html
@@ -341,17 +329,12 @@ Attributes
* - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo3_module__attribute-platform:
-
- .. rst-class:: ansible-option-title
-
- **platform**
-
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns.col2.foo3
+ plugin_type: module
+ name: "platform"
.. raw:: html
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/foo4_module.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/foo4_module.rst
index b7568c0f..4a062d2c 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/foo4_module.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/foo4_module.rst
@@ -20,6 +20,12 @@
ns.col2.foo4 module -- Markup reference linting test
++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns.col2.foo4
+ plugin_type: module
+ short_description: "Markup reference linting test"
+
.. Collection note
.. note::
@@ -78,17 +84,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo4_module__parameter-correct_array_stubs:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **correct_array_stubs**
-
- .. raw:: html
-
-
+ fqcn: ns.col2.foo4
+ plugin_type: module
+ name: "correct_array_stubs"
+ full_keys:
+ - ["correct_array_stubs"]
.. ansible-option-type-line::
@@ -124,17 +127,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo4_module__parameter-existing:
-
- .. rst-class:: ansible-option-title
-
- **existing**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns.col2.foo4
+ plugin_type: module
+ name: "existing"
+ full_keys:
+ - ["existing"]
.. ansible-option-type-line::
@@ -198,17 +198,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns.col2.foo4_module__parameter-incorrect_array_stubs:
-
- .. rst-class:: ansible-option-title
- **incorrect_array_stubs**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns.col2.foo4
+ plugin_type: module
+ name: "incorrect_array_stubs"
+ full_keys:
+ - ["incorrect_array_stubs"]
.. ansible-option-type-line::
@@ -242,17 +239,14 @@ Parameters
* - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo4_module__parameter-not_existing:
-
- .. rst-class:: ansible-option-title
-
- **not_existing**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns.col2.foo4
+ plugin_type: module
+ name: "not_existing"
+ full_keys:
+ - ["not_existing"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/foo_module.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/foo_module.rst
index 2a29132a..b65ba778 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/foo_module.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns/col2/foo_module.rst
@@ -17,6 +17,10 @@
ns.col2.foo module
++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns.col2.foo
+ plugin_type: module
The documentation for the module plugin, ns.col2.foo, was malformed.
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/bar_filter.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/bar_filter.rst
index 02bd2e03..02c0f5dd 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/bar_filter.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/bar_filter.rst
@@ -21,6 +21,12 @@
ns2.col.bar filter -- The bar filter
++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.bar
+ plugin_type: filter
+ short_description: "The bar filter"
+
.. Collection note
.. note::
@@ -84,17 +90,15 @@ This describes the input of the filter, the value before ``| ns2.col.bar``.
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.bar_filter__parameter-_input:
- .. rst-class:: ansible-option-title
-
- **Input**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.bar
+ plugin_type: filter
+ name: "Input"
+ full_keys:
+ - ["_input"]
+ special: input
.. ansible-option-type-line::
@@ -143,17 +147,15 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)``
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.bar_filter__parameter-foo:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **foo**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.bar
+ plugin_type: filter
+ name: "foo"
+ full_keys:
+ - ["foo"]
+ special: positional
.. ansible-option-type-line::
@@ -180,17 +182,15 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)``
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.bar_filter__parameter-bar:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.bar
+ plugin_type: filter
+ name: "bar"
+ full_keys:
+ - ["bar"]
+ special: positional
.. ansible-option-type-line::
@@ -246,17 +246,14 @@ example: ``input | ns2.col.bar(key1=value1, key2=value2, ...)``
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.bar_filter__parameter-baz:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **baz**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.bar
+ plugin_type: filter
+ name: "baz"
+ full_keys:
+ - ["baz"]
.. ansible-option-type-line::
@@ -351,17 +348,15 @@ Return Value
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.bar_filter__return-_value:
-
- .. rst-class:: ansible-option-title
- **Return value**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.bar
+ plugin_type: filter
+ name: "Return value"
+ full_keys:
+ - ["_value"]
+ special: return-value
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/bar_test.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/bar_test.rst
index 7f09cc31..5b6d4b71 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/bar_test.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/bar_test.rst
@@ -21,6 +21,12 @@
ns2.col.bar test -- Is something a bar
++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.bar
+ plugin_type: test
+ short_description: "Is something a bar"
+
.. Collection note
.. note::
@@ -82,17 +88,15 @@ This describes the input of the test, the value before ``is ns2.col.bar`` or ``i
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.bar_test__parameter-_input:
-
- .. rst-class:: ansible-option-title
-
- **Input**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.bar
+ plugin_type: test
+ name: "Input"
+ full_keys:
+ - ["_input"]
+ special: input
.. ansible-option-type-line::
@@ -165,17 +169,15 @@ Return Value
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.bar_test__return-_value:
-
- .. rst-class:: ansible-option-title
- **Return value**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.bar
+ plugin_type: test
+ name: "Return value"
+ full_keys:
+ - ["_value"]
+ special: return-value
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo2_module.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo2_module.rst
index 62ba96ab..27ace73c 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo2_module.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo2_module.rst
@@ -21,6 +21,12 @@
ns2.col.foo2 module -- Another foo
++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ short_description: "Another foo"
+
.. Collection note
.. note::
@@ -82,17 +88,14 @@ Parameters
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo2_module__parameter-bar:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -137,17 +140,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo2_module__attribute-action_group:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **action_group**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ name: "action_group"
.. raw:: html
@@ -179,17 +177,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo2_module__attribute-check_mode:
-
- .. rst-class:: ansible-option-title
-
- **check_mode**
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ name: "check_mode"
.. raw:: html
@@ -221,17 +214,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo2_module__attribute-diff_mode:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **diff_mode**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ name: "diff_mode"
.. raw:: html
@@ -263,17 +251,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo2_module__attribute-platform:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **platform**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ name: "platform"
.. raw:: html
@@ -347,17 +330,14 @@ Common return values are documented :ref:`here `, the foll
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo2_module__return-bar:
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_become.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_become.rst
index a2e2948f..ffe66ca2 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_become.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_become.rst
@@ -21,6 +21,12 @@
ns2.col.foo become -- Use foo \ :ansopt:`ns2.col.foo#become:bar`\
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: become
+ short_description: "Use foo \\ :ansopt:`ns2.col.foo#become:bar`\\ "
+
.. Collection note
.. note::
@@ -92,17 +98,14 @@ Parameters
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_become__parameter-bar:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: become
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -149,17 +152,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_become__parameter-become_exe:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **become_exe**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: become
+ name: "become_exe"
+ full_keys:
+ - ["become_exe"]
.. ansible-option-type-line::
@@ -244,17 +244,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_become__parameter-become_user:
- .. rst-class:: ansible-option-title
-
- **become_user**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: become
+ name: "become_user"
+ full_keys:
+ - ["become_user"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_cache.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_cache.rst
index 539a4ae9..84e75e86 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_cache.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_cache.rst
@@ -21,6 +21,12 @@
ns2.col.foo cache -- Foo files \ :ansopt:`ns2.col.foo#cache:bar`\
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: cache
+ short_description: "Foo files \\ :ansopt:`ns2.col.foo#cache:bar`\\ "
+
.. Collection note
.. note::
@@ -83,17 +89,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_cache__parameter-_uri:
-
- .. rst-class:: ansible-option-title
-
- **_uri**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: cache
+ name: "_uri"
+ full_keys:
+ - ["_uri"]
.. ansible-option-type-line::
@@ -135,17 +138,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_cache__parameter-bar:
-
- .. rst-class:: ansible-option-title
- **bar**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: cache
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_callback.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_callback.rst
index 9a277b2c..18e43008 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_callback.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_callback.rst
@@ -21,6 +21,12 @@
ns2.col.foo callback -- Foo output \ :ansopt:`ns2.col.foo#callback:bar`\
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: callback
+ short_description: "Foo output \\ :ansopt:`ns2.col.foo#callback:bar`\\ "
+
.. Collection note
.. note::
@@ -89,17 +95,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_callback__parameter-bar:
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: callback
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_cliconf.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_cliconf.rst
index b570e0a4..78a95549 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_cliconf.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_cliconf.rst
@@ -21,6 +21,12 @@
ns2.col.foo cliconf -- Foo router CLI config
++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: cliconf
+ short_description: "Foo router CLI config"
+
.. Collection note
.. note::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_connection.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_connection.rst
index 84d69342..821a5ef5 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_connection.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_connection.rst
@@ -21,6 +21,12 @@
ns2.col.foo connection -- Foo connection \ :ansopt:`ns2.col.foo#connection:bar`\
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: connection
+ short_description: "Foo connection \\ :ansopt:`ns2.col.foo#connection:bar`\\ "
+
.. Collection note
.. note::
@@ -83,17 +89,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_connection__parameter-bar:
-
- .. rst-class:: ansible-option-title
-
- **bar**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: connection
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -120,17 +123,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_connection__parameter-host:
-
- .. rst-class:: ansible-option-title
- **host**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: connection
+ name: "host"
+ full_keys:
+ - ["host"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_filter.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_filter.rst
index aafe1534..1e13419a 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_filter.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_filter.rst
@@ -21,6 +21,12 @@
ns2.col.foo filter -- The foo filter \ :ansopt:`ns2.col.foo#filter:bar`\
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: filter
+ short_description: "The foo filter \\ :ansopt:`ns2.col.foo#filter:bar`\\ "
+
.. Collection note
.. note::
@@ -84,17 +90,15 @@ This describes the input of the filter, the value before ``| ns2.col.foo``.
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_filter__parameter-_input:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **Input**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: filter
+ name: "Input"
+ full_keys:
+ - ["_input"]
+ special: input
.. ansible-option-type-line::
@@ -143,17 +147,14 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_filter__parameter-bar:
-
- .. rst-class:: ansible-option-title
-
- **bar**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: filter
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -180,17 +181,14 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_filter__parameter-foo:
-
- .. rst-class:: ansible-option-title
- **foo**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: filter
+ name: "foo"
+ full_keys:
+ - ["foo"]
.. ansible-option-type-line::
@@ -259,17 +257,15 @@ Return Value
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_filter__return-_value:
-
- .. rst-class:: ansible-option-title
-
- **Return value**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.foo
+ plugin_type: filter
+ name: "Return value"
+ full_keys:
+ - ["_value"]
+ special: return-value
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_inventory.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_inventory.rst
index abce5ac6..f7256178 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_inventory.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_inventory.rst
@@ -21,6 +21,12 @@
ns2.col.foo inventory -- The foo inventory \ :ansopt:`ns2.col.foo#inventory:bar`\
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: inventory
+ short_description: "The foo inventory \\ :ansopt:`ns2.col.foo#inventory:bar`\\ "
+
.. Collection note
.. note::
@@ -83,17 +89,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_inventory__parameter-bar:
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: inventory
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_lookup.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_lookup.rst
index f4e53de0..39baa675 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_lookup.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_lookup.rst
@@ -21,6 +21,12 @@
ns2.col.foo lookup -- Look up some foo \ :ansopt:`ns2.col.foo#lookup:bar`\
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: lookup
+ short_description: "Look up some foo \\ :ansopt:`ns2.col.foo#lookup:bar`\\ "
+
.. Collection note
.. note::
@@ -82,17 +88,15 @@ Terms
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_lookup__parameter-_terms:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **Terms**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: lookup
+ name: "Terms"
+ full_keys:
+ - ["_terms"]
+ special: terms
.. ansible-option-type-line::
@@ -142,17 +146,14 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query('
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_lookup__parameter-bar:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: lookup
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -229,17 +230,15 @@ Return Value
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_lookup__return-_raw:
- .. rst-class:: ansible-option-title
-
- **Return value**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.foo
+ plugin_type: lookup
+ name: "Return value"
+ full_keys:
+ - ["_raw"]
+ special: return-value
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_module.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_module.rst
index 1f14bfe6..c47f1926 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_module.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_module.rst
@@ -21,6 +21,12 @@
ns2.col.foo module -- Do some foo \ :ansopt:`ns2.col.foo#module:bar`\
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: module
+ short_description: "Do some foo \\ :ansopt:`ns2.col.foo#module:bar`\\ "
+
.. Collection note
.. note::
@@ -64,10 +70,14 @@ Aliases: foo_redirect
.. Requirements
-.. _ansible_collections.ns2.col.foo_module_requirements:
-
Requirements
------------
+
+.. ansible-requirements-anchor::
+
+ fqcn: ns2.col.foo
+ plugin_type: module
+
The below requirements are needed on the host that executes this module.
- Foo on remote.
@@ -96,19 +106,15 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__parameter-bar:
- .. _ansible_collections.ns2.col.foo_module__parameter-baz:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
+ - ["baz"]
.. ansible-option-type-line::
@@ -138,17 +144,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__parameter-foo:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **foo**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["foo"]
.. ansible-option-type-line::
@@ -172,17 +175,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__parameter-subfoo:
-
- .. rst-class:: ansible-option-title
- **subfoo**
+ .. ansible-option::
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "subfoo"
+ full_keys:
+ - ["subfoo"]
.. ansible-option-type-line::
@@ -209,21 +209,18 @@ Parameters
* - .. raw:: html
-
.. raw:: latex
\hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
- .. _ansible_collections.ns2.col.foo_module__parameter-subfoo/foo:
-
- .. rst-class:: ansible-option-title
-
- **foo**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["subfoo", "foo"]
.. ansible-option-type-line::
@@ -275,17 +272,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__attribute-action_group:
-
- .. rst-class:: ansible-option-title
- **action_group**
+ .. ansible-attribute::
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "action_group"
.. raw:: html
@@ -317,17 +309,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__attribute-check_mode:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **check_mode**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "check_mode"
.. raw:: html
@@ -359,17 +346,12 @@ Attributes
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_module__attribute-diff_mode:
+ .. ansible-attribute::
- .. rst-class:: ansible-option-title
-
- **diff_mode**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "diff_mode"
.. raw:: html
@@ -401,17 +383,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__attribute-platform:
-
- .. rst-class:: ansible-option-title
-
- **platform**
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "platform"
.. raw:: html
@@ -504,17 +481,14 @@ Common return values are documented :ref:`here `, the foll
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__return-bar:
-
- .. rst-class:: ansible-option-title
- **bar**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_redirect_module.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_redirect_module.rst
index 2b01a6c0..10b231f5 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_redirect_module.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_redirect_module.rst
@@ -15,6 +15,11 @@
ns2.col.foo_redirect module
+++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo_redirect
+ plugin_type: module
+
.. Collection note
.. note::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_role.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_role.rst
index dd66290c..205b6000 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_role.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_role.rst
@@ -19,6 +19,12 @@
ns2.col.foo role -- Foo role
++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: role
+ short_description: "Foo role"
+
.. Collection note
.. note::
@@ -41,6 +47,12 @@ ns2.col.foo role -- Foo role
Entry point ``main`` -- Foo role
--------------------------------
+.. ansible-role-entrypoint::
+
+ fqcn: ns2.col.foo
+ entrypoint: main
+ short_description: "Foo role"
+
.. version_added
.. rst-class:: ansible-version-added
@@ -91,17 +103,15 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_role__parameter-main__foo_param_1:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **foo_param_1**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: role
+ role_entrypoint: "main"
+ name: "foo_param_1"
+ full_keys:
+ - ["foo_param_1"]
.. ansible-option-type-line::
@@ -130,17 +140,15 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_role__parameter-main__foo_param_2:
-
- .. rst-class:: ansible-option-title
- **foo_param_2**
+ .. ansible-option::
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: role
+ role_entrypoint: "main"
+ name: "foo_param_2"
+ full_keys:
+ - ["foo_param_2"]
.. ansible-option-type-line::
@@ -190,17 +198,13 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_role__attribute-main__check_mode:
-
- .. rst-class:: ansible-option-title
-
- **check_mode**
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns2.col.foo
+ plugin_type: role
+ role_entrypoint: "main"
+ name: "check_mode"
.. raw:: html
@@ -232,17 +236,13 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_role__attribute-main__platform:
-
- .. rst-class:: ansible-option-title
- **platform**
-
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns2.col.foo
+ plugin_type: role
+ role_entrypoint: "main"
+ name: "platform"
.. raw:: html
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_shell.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_shell.rst
index b021c328..5e0dccf9 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_shell.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_shell.rst
@@ -21,6 +21,12 @@
ns2.col.foo shell -- Foo shell \ :ansopt:`ns2.col.foo#shell:bar`\
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: shell
+ short_description: "Foo shell \\ :ansopt:`ns2.col.foo#shell:bar`\\ "
+
.. Collection note
.. note::
@@ -83,17 +89,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_shell__parameter-bar:
-
- .. rst-class:: ansible-option-title
-
- **bar**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: shell
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -120,17 +123,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_shell__parameter-remote_tmp:
-
- .. rst-class:: ansible-option-title
- **remote_tmp**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: shell
+ name: "remote_tmp"
+ full_keys:
+ - ["remote_tmp"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_strategy.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_strategy.rst
index 8d8b164e..71f93dda 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_strategy.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_strategy.rst
@@ -21,6 +21,12 @@
ns2.col.foo strategy -- Executes tasks in foo
+++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: strategy
+ short_description: "Executes tasks in foo"
+
.. Collection note
.. note::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_test.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_test.rst
index b369f125..9bec8320 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_test.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_test.rst
@@ -21,6 +21,12 @@
ns2.col.foo test -- Is something a foo \ :ansopt:`ns2.col.foo#test:bar`\
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: test
+ short_description: "Is something a foo \\ :ansopt:`ns2.col.foo#test:bar`\\ "
+
.. Collection note
.. note::
@@ -81,17 +87,15 @@ This describes the input of the test, the value before ``is ns2.col.foo`` or ``i
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_test__parameter-_input:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **Input**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: test
+ name: "Input"
+ full_keys:
+ - ["_input"]
+ special: input
.. ansible-option-type-line::
@@ -140,17 +144,14 @@ examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_test__parameter-bar:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: test
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -219,17 +220,15 @@ Return Value
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_test__return-_value:
- .. rst-class:: ansible-option-title
-
- **Return value**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.foo
+ plugin_type: test
+ name: "Return value"
+ full_keys:
+ - ["_value"]
+ special: return-value
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_vars.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_vars.rst
index f460e625..943dfc7b 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_vars.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/foo_vars.rst
@@ -21,6 +21,12 @@
ns2.col.foo vars -- Load foo \ :ansopt:`ns2.col.foo#vars:bar`\
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: vars
+ short_description: "Load foo \\ :ansopt:`ns2.col.foo#vars:bar`\\ "
+
.. Collection note
.. note::
@@ -62,10 +68,14 @@ Synopsis
.. Requirements
-.. _ansible_collections.ns2.col.foo_vars_requirements:
-
Requirements
------------
+
+.. ansible-requirements-anchor::
+
+ fqcn: ns2.col.foo
+ plugin_type: vars
+
The below requirements are needed on the local controller node that executes this vars.
- Enabled in Ansible's configuration.
@@ -94,17 +104,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_vars__parameter-_valid_extensions:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **_valid_extensions**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: vars
+ name: "_valid_extensions"
+ full_keys:
+ - ["_valid_extensions"]
.. ansible-option-type-line::
@@ -150,17 +157,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_vars__parameter-bar:
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: vars
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/is_bar_test.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/is_bar_test.rst
index 86dbccab..21ce1a6c 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/is_bar_test.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/is_bar_test.rst
@@ -15,6 +15,11 @@
ns2.col.is_bar test
+++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.is_bar
+ plugin_type: test
+
.. Collection note
.. note::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/sub.foo3_module.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/sub.foo3_module.rst
index b55705df..f01c5e54 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/sub.foo3_module.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/sub.foo3_module.rst
@@ -21,6 +21,12 @@
ns2.col.sub.foo3 module -- A sub-foo
++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ short_description: "A sub-foo"
+
.. Collection note
.. note::
@@ -81,17 +87,14 @@ Parameters
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.sub.foo3_module__parameter-bar:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -136,17 +139,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.sub.foo3_module__attribute-action_group:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **action_group**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ name: "action_group"
.. raw:: html
@@ -178,17 +176,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.sub.foo3_module__attribute-check_mode:
-
- .. rst-class:: ansible-option-title
-
- **check_mode**
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ name: "check_mode"
.. raw:: html
@@ -220,17 +213,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.sub.foo3_module__attribute-diff_mode:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **diff_mode**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ name: "diff_mode"
.. raw:: html
@@ -262,17 +250,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.sub.foo3_module__attribute-platform:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **platform**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ name: "platform"
.. raw:: html
@@ -346,17 +329,14 @@ Common return values are documented :ref:`here `, the foll
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.sub.foo3_module__return-bar:
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/flatcol/foo2_module.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/flatcol/foo2_module.rst
index 4d2793e5..22ccc905 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/flatcol/foo2_module.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/flatcol/foo2_module.rst
@@ -20,6 +20,12 @@
ns2.flatcol.foo2 module -- Another foo
++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.flatcol.foo2
+ plugin_type: module
+ short_description: "Another foo"
+
.. Collection note
.. note::
@@ -80,17 +86,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.flatcol.foo2_module__parameter-bar:
-
- .. rst-class:: ansible-option-title
-
- **bar**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.flatcol.foo2
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -161,17 +164,14 @@ Common return values are documented :ref:`here `, the foll
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.flatcol.foo2_module__return-bar:
-
- .. rst-class:: ansible-option-title
- **bar**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.flatcol.foo2
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/flatcol/foo_module.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/flatcol/foo_module.rst
index 427b32f3..0542d34a 100644
--- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/flatcol/foo_module.rst
+++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/flatcol/foo_module.rst
@@ -20,6 +20,12 @@
ns2.flatcol.foo module -- Do some foo \ :ansopt:`ns2.flatcol.foo#module:bar`\
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.flatcol.foo
+ plugin_type: module
+ short_description: "Do some foo \\ :ansopt:`ns2.flatcol.foo#module:bar`\\ "
+
.. Collection note
.. note::
@@ -83,19 +89,15 @@ Parameters
* - .. raw:: html
-
-
-
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-bar:
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-baz:
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.flatcol.foo
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
+ - ["baz"]
.. ansible-option-type-line::
@@ -125,17 +127,14 @@ Parameters
* - .. raw:: html
-
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-foo:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **foo**
-
- .. raw:: html
-
-
+ fqcn: ns2.flatcol.foo
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["foo"]
.. ansible-option-type-line::
@@ -159,19 +158,15 @@ Parameters
* - .. raw:: html
-
-
-
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-subbaz:
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-subfoo:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **subfoo**
-
- .. raw:: html
-
-
+ fqcn: ns2.flatcol.foo
+ plugin_type: module
+ name: "subfoo"
+ full_keys:
+ - ["subfoo"]
+ - ["subbaz"]
.. ansible-option-type-line::
@@ -200,27 +195,21 @@ Parameters
* - .. raw:: html
-
-
-
-
.. raw:: latex
\hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-subbaz/bam:
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-subbaz/foo:
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-subfoo/bam:
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-subfoo/foo:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **foo**
-
- .. raw:: html
-
-
+ fqcn: ns2.flatcol.foo
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["subfoo", "foo"]
+ - ["subbaz", "foo"]
+ - ["subfoo", "bam"]
+ - ["subbaz", "bam"]
.. ansible-option-type-line::
@@ -310,17 +299,14 @@ Common return values are documented :ref:`here `, the foll
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.flatcol.foo_module__return-bar:
-
- .. rst-class:: ansible-option-title
- **bar**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.flatcol.foo
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/bar_filter.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/bar_filter.rst
index 02bd2e03..02c0f5dd 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/bar_filter.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/bar_filter.rst
@@ -21,6 +21,12 @@
ns2.col.bar filter -- The bar filter
++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.bar
+ plugin_type: filter
+ short_description: "The bar filter"
+
.. Collection note
.. note::
@@ -84,17 +90,15 @@ This describes the input of the filter, the value before ``| ns2.col.bar``.
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.bar_filter__parameter-_input:
- .. rst-class:: ansible-option-title
-
- **Input**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.bar
+ plugin_type: filter
+ name: "Input"
+ full_keys:
+ - ["_input"]
+ special: input
.. ansible-option-type-line::
@@ -143,17 +147,15 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)``
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.bar_filter__parameter-foo:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **foo**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.bar
+ plugin_type: filter
+ name: "foo"
+ full_keys:
+ - ["foo"]
+ special: positional
.. ansible-option-type-line::
@@ -180,17 +182,15 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)``
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.bar_filter__parameter-bar:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.bar
+ plugin_type: filter
+ name: "bar"
+ full_keys:
+ - ["bar"]
+ special: positional
.. ansible-option-type-line::
@@ -246,17 +246,14 @@ example: ``input | ns2.col.bar(key1=value1, key2=value2, ...)``
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.bar_filter__parameter-baz:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **baz**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.bar
+ plugin_type: filter
+ name: "baz"
+ full_keys:
+ - ["baz"]
.. ansible-option-type-line::
@@ -351,17 +348,15 @@ Return Value
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.bar_filter__return-_value:
-
- .. rst-class:: ansible-option-title
- **Return value**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.bar
+ plugin_type: filter
+ name: "Return value"
+ full_keys:
+ - ["_value"]
+ special: return-value
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/bar_test.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/bar_test.rst
index 7f09cc31..5b6d4b71 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/bar_test.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/bar_test.rst
@@ -21,6 +21,12 @@
ns2.col.bar test -- Is something a bar
++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.bar
+ plugin_type: test
+ short_description: "Is something a bar"
+
.. Collection note
.. note::
@@ -82,17 +88,15 @@ This describes the input of the test, the value before ``is ns2.col.bar`` or ``i
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.bar_test__parameter-_input:
-
- .. rst-class:: ansible-option-title
-
- **Input**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.bar
+ plugin_type: test
+ name: "Input"
+ full_keys:
+ - ["_input"]
+ special: input
.. ansible-option-type-line::
@@ -165,17 +169,15 @@ Return Value
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.bar_test__return-_value:
-
- .. rst-class:: ansible-option-title
- **Return value**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.bar
+ plugin_type: test
+ name: "Return value"
+ full_keys:
+ - ["_value"]
+ special: return-value
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo2_module.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo2_module.rst
index 62ba96ab..27ace73c 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo2_module.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo2_module.rst
@@ -21,6 +21,12 @@
ns2.col.foo2 module -- Another foo
++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ short_description: "Another foo"
+
.. Collection note
.. note::
@@ -82,17 +88,14 @@ Parameters
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo2_module__parameter-bar:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -137,17 +140,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo2_module__attribute-action_group:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **action_group**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ name: "action_group"
.. raw:: html
@@ -179,17 +177,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo2_module__attribute-check_mode:
-
- .. rst-class:: ansible-option-title
-
- **check_mode**
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ name: "check_mode"
.. raw:: html
@@ -221,17 +214,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo2_module__attribute-diff_mode:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **diff_mode**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ name: "diff_mode"
.. raw:: html
@@ -263,17 +251,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo2_module__attribute-platform:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **platform**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ name: "platform"
.. raw:: html
@@ -347,17 +330,14 @@ Common return values are documented :ref:`here `, the foll
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo2_module__return-bar:
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.foo2
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_become.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_become.rst
index a2e2948f..ffe66ca2 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_become.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_become.rst
@@ -21,6 +21,12 @@
ns2.col.foo become -- Use foo \ :ansopt:`ns2.col.foo#become:bar`\
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: become
+ short_description: "Use foo \\ :ansopt:`ns2.col.foo#become:bar`\\ "
+
.. Collection note
.. note::
@@ -92,17 +98,14 @@ Parameters
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_become__parameter-bar:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: become
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -149,17 +152,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_become__parameter-become_exe:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **become_exe**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: become
+ name: "become_exe"
+ full_keys:
+ - ["become_exe"]
.. ansible-option-type-line::
@@ -244,17 +244,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_become__parameter-become_user:
- .. rst-class:: ansible-option-title
-
- **become_user**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: become
+ name: "become_user"
+ full_keys:
+ - ["become_user"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_cache.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_cache.rst
index 539a4ae9..84e75e86 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_cache.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_cache.rst
@@ -21,6 +21,12 @@
ns2.col.foo cache -- Foo files \ :ansopt:`ns2.col.foo#cache:bar`\
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: cache
+ short_description: "Foo files \\ :ansopt:`ns2.col.foo#cache:bar`\\ "
+
.. Collection note
.. note::
@@ -83,17 +89,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_cache__parameter-_uri:
-
- .. rst-class:: ansible-option-title
-
- **_uri**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: cache
+ name: "_uri"
+ full_keys:
+ - ["_uri"]
.. ansible-option-type-line::
@@ -135,17 +138,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_cache__parameter-bar:
-
- .. rst-class:: ansible-option-title
- **bar**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: cache
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_callback.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_callback.rst
index 9a277b2c..18e43008 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_callback.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_callback.rst
@@ -21,6 +21,12 @@
ns2.col.foo callback -- Foo output \ :ansopt:`ns2.col.foo#callback:bar`\
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: callback
+ short_description: "Foo output \\ :ansopt:`ns2.col.foo#callback:bar`\\ "
+
.. Collection note
.. note::
@@ -89,17 +95,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_callback__parameter-bar:
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: callback
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_cliconf.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_cliconf.rst
index b570e0a4..78a95549 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_cliconf.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_cliconf.rst
@@ -21,6 +21,12 @@
ns2.col.foo cliconf -- Foo router CLI config
++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: cliconf
+ short_description: "Foo router CLI config"
+
.. Collection note
.. note::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_connection.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_connection.rst
index 84d69342..821a5ef5 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_connection.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_connection.rst
@@ -21,6 +21,12 @@
ns2.col.foo connection -- Foo connection \ :ansopt:`ns2.col.foo#connection:bar`\
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: connection
+ short_description: "Foo connection \\ :ansopt:`ns2.col.foo#connection:bar`\\ "
+
.. Collection note
.. note::
@@ -83,17 +89,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_connection__parameter-bar:
-
- .. rst-class:: ansible-option-title
-
- **bar**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: connection
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -120,17 +123,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_connection__parameter-host:
-
- .. rst-class:: ansible-option-title
- **host**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: connection
+ name: "host"
+ full_keys:
+ - ["host"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_filter.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_filter.rst
index aafe1534..1e13419a 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_filter.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_filter.rst
@@ -21,6 +21,12 @@
ns2.col.foo filter -- The foo filter \ :ansopt:`ns2.col.foo#filter:bar`\
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: filter
+ short_description: "The foo filter \\ :ansopt:`ns2.col.foo#filter:bar`\\ "
+
.. Collection note
.. note::
@@ -84,17 +90,15 @@ This describes the input of the filter, the value before ``| ns2.col.foo``.
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_filter__parameter-_input:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **Input**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: filter
+ name: "Input"
+ full_keys:
+ - ["_input"]
+ special: input
.. ansible-option-type-line::
@@ -143,17 +147,14 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_filter__parameter-bar:
-
- .. rst-class:: ansible-option-title
-
- **bar**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: filter
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -180,17 +181,14 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_filter__parameter-foo:
-
- .. rst-class:: ansible-option-title
- **foo**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: filter
+ name: "foo"
+ full_keys:
+ - ["foo"]
.. ansible-option-type-line::
@@ -259,17 +257,15 @@ Return Value
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_filter__return-_value:
-
- .. rst-class:: ansible-option-title
-
- **Return value**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.foo
+ plugin_type: filter
+ name: "Return value"
+ full_keys:
+ - ["_value"]
+ special: return-value
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_inventory.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_inventory.rst
index abce5ac6..f7256178 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_inventory.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_inventory.rst
@@ -21,6 +21,12 @@
ns2.col.foo inventory -- The foo inventory \ :ansopt:`ns2.col.foo#inventory:bar`\
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: inventory
+ short_description: "The foo inventory \\ :ansopt:`ns2.col.foo#inventory:bar`\\ "
+
.. Collection note
.. note::
@@ -83,17 +89,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_inventory__parameter-bar:
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: inventory
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_lookup.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_lookup.rst
index f4e53de0..39baa675 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_lookup.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_lookup.rst
@@ -21,6 +21,12 @@
ns2.col.foo lookup -- Look up some foo \ :ansopt:`ns2.col.foo#lookup:bar`\
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: lookup
+ short_description: "Look up some foo \\ :ansopt:`ns2.col.foo#lookup:bar`\\ "
+
.. Collection note
.. note::
@@ -82,17 +88,15 @@ Terms
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_lookup__parameter-_terms:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **Terms**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: lookup
+ name: "Terms"
+ full_keys:
+ - ["_terms"]
+ special: terms
.. ansible-option-type-line::
@@ -142,17 +146,14 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query('
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_lookup__parameter-bar:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: lookup
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -229,17 +230,15 @@ Return Value
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_lookup__return-_raw:
- .. rst-class:: ansible-option-title
-
- **Return value**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.foo
+ plugin_type: lookup
+ name: "Return value"
+ full_keys:
+ - ["_raw"]
+ special: return-value
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_module.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_module.rst
index 1f14bfe6..c47f1926 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_module.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_module.rst
@@ -21,6 +21,12 @@
ns2.col.foo module -- Do some foo \ :ansopt:`ns2.col.foo#module:bar`\
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: module
+ short_description: "Do some foo \\ :ansopt:`ns2.col.foo#module:bar`\\ "
+
.. Collection note
.. note::
@@ -64,10 +70,14 @@ Aliases: foo_redirect
.. Requirements
-.. _ansible_collections.ns2.col.foo_module_requirements:
-
Requirements
------------
+
+.. ansible-requirements-anchor::
+
+ fqcn: ns2.col.foo
+ plugin_type: module
+
The below requirements are needed on the host that executes this module.
- Foo on remote.
@@ -96,19 +106,15 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__parameter-bar:
- .. _ansible_collections.ns2.col.foo_module__parameter-baz:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
+ - ["baz"]
.. ansible-option-type-line::
@@ -138,17 +144,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__parameter-foo:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **foo**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["foo"]
.. ansible-option-type-line::
@@ -172,17 +175,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__parameter-subfoo:
-
- .. rst-class:: ansible-option-title
- **subfoo**
+ .. ansible-option::
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "subfoo"
+ full_keys:
+ - ["subfoo"]
.. ansible-option-type-line::
@@ -209,21 +209,18 @@ Parameters
* - .. raw:: html
-
.. raw:: latex
\hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
- .. _ansible_collections.ns2.col.foo_module__parameter-subfoo/foo:
-
- .. rst-class:: ansible-option-title
-
- **foo**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["subfoo", "foo"]
.. ansible-option-type-line::
@@ -275,17 +272,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__attribute-action_group:
-
- .. rst-class:: ansible-option-title
- **action_group**
+ .. ansible-attribute::
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "action_group"
.. raw:: html
@@ -317,17 +309,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__attribute-check_mode:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **check_mode**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "check_mode"
.. raw:: html
@@ -359,17 +346,12 @@ Attributes
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_module__attribute-diff_mode:
+ .. ansible-attribute::
- .. rst-class:: ansible-option-title
-
- **diff_mode**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "diff_mode"
.. raw:: html
@@ -401,17 +383,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__attribute-platform:
-
- .. rst-class:: ansible-option-title
-
- **platform**
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "platform"
.. raw:: html
@@ -504,17 +481,14 @@ Common return values are documented :ref:`here `, the foll
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_module__return-bar:
-
- .. rst-class:: ansible-option-title
- **bar**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.foo
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_redirect_module.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_redirect_module.rst
index 2b01a6c0..10b231f5 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_redirect_module.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_redirect_module.rst
@@ -15,6 +15,11 @@
ns2.col.foo_redirect module
+++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo_redirect
+ plugin_type: module
+
.. Collection note
.. note::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_role.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_role.rst
index dd66290c..205b6000 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_role.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_role.rst
@@ -19,6 +19,12 @@
ns2.col.foo role -- Foo role
++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: role
+ short_description: "Foo role"
+
.. Collection note
.. note::
@@ -41,6 +47,12 @@ ns2.col.foo role -- Foo role
Entry point ``main`` -- Foo role
--------------------------------
+.. ansible-role-entrypoint::
+
+ fqcn: ns2.col.foo
+ entrypoint: main
+ short_description: "Foo role"
+
.. version_added
.. rst-class:: ansible-version-added
@@ -91,17 +103,15 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_role__parameter-main__foo_param_1:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **foo_param_1**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: role
+ role_entrypoint: "main"
+ name: "foo_param_1"
+ full_keys:
+ - ["foo_param_1"]
.. ansible-option-type-line::
@@ -130,17 +140,15 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_role__parameter-main__foo_param_2:
-
- .. rst-class:: ansible-option-title
- **foo_param_2**
+ .. ansible-option::
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: role
+ role_entrypoint: "main"
+ name: "foo_param_2"
+ full_keys:
+ - ["foo_param_2"]
.. ansible-option-type-line::
@@ -190,17 +198,13 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_role__attribute-main__check_mode:
-
- .. rst-class:: ansible-option-title
-
- **check_mode**
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns2.col.foo
+ plugin_type: role
+ role_entrypoint: "main"
+ name: "check_mode"
.. raw:: html
@@ -232,17 +236,13 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_role__attribute-main__platform:
-
- .. rst-class:: ansible-option-title
- **platform**
-
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns2.col.foo
+ plugin_type: role
+ role_entrypoint: "main"
+ name: "platform"
.. raw:: html
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_shell.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_shell.rst
index b021c328..5e0dccf9 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_shell.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_shell.rst
@@ -21,6 +21,12 @@
ns2.col.foo shell -- Foo shell \ :ansopt:`ns2.col.foo#shell:bar`\
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: shell
+ short_description: "Foo shell \\ :ansopt:`ns2.col.foo#shell:bar`\\ "
+
.. Collection note
.. note::
@@ -83,17 +89,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_shell__parameter-bar:
-
- .. rst-class:: ansible-option-title
-
- **bar**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: shell
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -120,17 +123,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_shell__parameter-remote_tmp:
-
- .. rst-class:: ansible-option-title
- **remote_tmp**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: shell
+ name: "remote_tmp"
+ full_keys:
+ - ["remote_tmp"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_strategy.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_strategy.rst
index 8d8b164e..71f93dda 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_strategy.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_strategy.rst
@@ -21,6 +21,12 @@
ns2.col.foo strategy -- Executes tasks in foo
+++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: strategy
+ short_description: "Executes tasks in foo"
+
.. Collection note
.. note::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_test.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_test.rst
index b369f125..9bec8320 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_test.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_test.rst
@@ -21,6 +21,12 @@
ns2.col.foo test -- Is something a foo \ :ansopt:`ns2.col.foo#test:bar`\
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: test
+ short_description: "Is something a foo \\ :ansopt:`ns2.col.foo#test:bar`\\ "
+
.. Collection note
.. note::
@@ -81,17 +87,15 @@ This describes the input of the test, the value before ``is ns2.col.foo`` or ``i
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_test__parameter-_input:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **Input**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: test
+ name: "Input"
+ full_keys:
+ - ["_input"]
+ special: input
.. ansible-option-type-line::
@@ -140,17 +144,14 @@ examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_test__parameter-bar:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: test
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -219,17 +220,15 @@ Return Value
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_test__return-_value:
- .. rst-class:: ansible-option-title
-
- **Return value**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.foo
+ plugin_type: test
+ name: "Return value"
+ full_keys:
+ - ["_value"]
+ special: return-value
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_vars.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_vars.rst
index f460e625..943dfc7b 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/foo_vars.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/foo_vars.rst
@@ -21,6 +21,12 @@
ns2.col.foo vars -- Load foo \ :ansopt:`ns2.col.foo#vars:bar`\
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.foo
+ plugin_type: vars
+ short_description: "Load foo \\ :ansopt:`ns2.col.foo#vars:bar`\\ "
+
.. Collection note
.. note::
@@ -62,10 +68,14 @@ Synopsis
.. Requirements
-.. _ansible_collections.ns2.col.foo_vars_requirements:
-
Requirements
------------
+
+.. ansible-requirements-anchor::
+
+ fqcn: ns2.col.foo
+ plugin_type: vars
+
The below requirements are needed on the local controller node that executes this vars.
- Enabled in Ansible's configuration.
@@ -94,17 +104,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_vars__parameter-_valid_extensions:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **_valid_extensions**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.foo
+ plugin_type: vars
+ name: "_valid_extensions"
+ full_keys:
+ - ["_valid_extensions"]
.. ansible-option-type-line::
@@ -150,17 +157,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.foo_vars__parameter-bar:
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.col.foo
+ plugin_type: vars
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/is_bar_test.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/is_bar_test.rst
index 86dbccab..21ce1a6c 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/is_bar_test.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/is_bar_test.rst
@@ -15,6 +15,11 @@
ns2.col.is_bar test
+++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.is_bar
+ plugin_type: test
+
.. Collection note
.. note::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/sub.foo3_module.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/sub.foo3_module.rst
index b55705df..f01c5e54 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/col/sub.foo3_module.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/col/sub.foo3_module.rst
@@ -21,6 +21,12 @@
ns2.col.sub.foo3 module -- A sub-foo
++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ short_description: "A sub-foo"
+
.. Collection note
.. note::
@@ -81,17 +87,14 @@ Parameters
* - .. raw:: html
-
- .. _ansible_collections.ns2.col.sub.foo3_module__parameter-bar:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -136,17 +139,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.sub.foo3_module__attribute-action_group:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **action_group**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ name: "action_group"
.. raw:: html
@@ -178,17 +176,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.sub.foo3_module__attribute-check_mode:
-
- .. rst-class:: ansible-option-title
-
- **check_mode**
- .. raw:: html
+ .. ansible-attribute::
-
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ name: "check_mode"
.. raw:: html
@@ -220,17 +213,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.sub.foo3_module__attribute-diff_mode:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **diff_mode**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ name: "diff_mode"
.. raw:: html
@@ -262,17 +250,12 @@ Attributes
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.sub.foo3_module__attribute-platform:
- .. rst-class:: ansible-option-title
+ .. ansible-attribute::
- **platform**
-
- .. raw:: html
-
-
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ name: "platform"
.. raw:: html
@@ -346,17 +329,14 @@ Common return values are documented :ref:`here `, the foll
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.col.sub.foo3_module__return-bar:
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.col.sub.foo3
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/flatcol/foo2_module.rst b/tests/functional/baseline-no-indexes/collections/ns2/flatcol/foo2_module.rst
index 4d2793e5..22ccc905 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/flatcol/foo2_module.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/flatcol/foo2_module.rst
@@ -20,6 +20,12 @@
ns2.flatcol.foo2 module -- Another foo
++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.flatcol.foo2
+ plugin_type: module
+ short_description: "Another foo"
+
.. Collection note
.. note::
@@ -80,17 +86,14 @@ Parameters
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.flatcol.foo2_module__parameter-bar:
-
- .. rst-class:: ansible-option-title
-
- **bar**
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.flatcol.foo2
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
@@ -161,17 +164,14 @@ Common return values are documented :ref:`here `, the foll
* - .. raw:: html
-
-
- .. _ansible_collections.ns2.flatcol.foo2_module__return-bar:
-
- .. rst-class:: ansible-option-title
- **bar**
-
- .. raw:: html
+ .. ansible-return-value::
-
+ fqcn: ns2.flatcol.foo2
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
.. ansible-option-type-line::
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/flatcol/foo_module.rst b/tests/functional/baseline-no-indexes/collections/ns2/flatcol/foo_module.rst
index 427b32f3..0542d34a 100644
--- a/tests/functional/baseline-no-indexes/collections/ns2/flatcol/foo_module.rst
+++ b/tests/functional/baseline-no-indexes/collections/ns2/flatcol/foo_module.rst
@@ -20,6 +20,12 @@
ns2.flatcol.foo module -- Do some foo \ :ansopt:`ns2.flatcol.foo#module:bar`\
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ansible-plugin::
+
+ fqcn: ns2.flatcol.foo
+ plugin_type: module
+ short_description: "Do some foo \\ :ansopt:`ns2.flatcol.foo#module:bar`\\ "
+
.. Collection note
.. note::
@@ -83,19 +89,15 @@ Parameters
* - .. raw:: html
-
-
-
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-bar:
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-baz:
- .. rst-class:: ansible-option-title
-
- **bar**
-
- .. raw:: html
+ .. ansible-option::
-
+ fqcn: ns2.flatcol.foo
+ plugin_type: module
+ name: "bar"
+ full_keys:
+ - ["bar"]
+ - ["baz"]
.. ansible-option-type-line::
@@ -125,17 +127,14 @@ Parameters
* - .. raw:: html
-
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-foo:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **foo**
-
- .. raw:: html
-
-
+ fqcn: ns2.flatcol.foo
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["foo"]
.. ansible-option-type-line::
@@ -159,19 +158,15 @@ Parameters
* - .. raw:: html
-
-
-
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-subbaz:
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-subfoo:
- .. rst-class:: ansible-option-title
+ .. ansible-option::
- **subfoo**
-
- .. raw:: html
-
-
+ fqcn: ns2.flatcol.foo
+ plugin_type: module
+ name: "subfoo"
+ full_keys:
+ - ["subfoo"]
+ - ["subbaz"]
.. ansible-option-type-line::
@@ -200,27 +195,21 @@ Parameters
* - .. raw:: html
-
-
-
-
.. raw:: latex
\hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-subbaz/bam:
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-subbaz/foo:
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-subfoo/bam:
- .. _ansible_collections.ns2.flatcol.foo_module__parameter-subfoo/foo:
+ .. ansible-option::
- .. rst-class:: ansible-option-title
-
- **foo**
-
- .. raw:: html
-
-
+ fqcn: ns2.flatcol.foo
+ plugin_type: module
+ name: "foo"
+ full_keys:
+ - ["subfoo", "foo"]
+ - ["subbaz", "foo"]
+ - ["subfoo", "bam"]
+ - ["subbaz", "bam"]
.. ansible-option-type-line::
@@ -310,17 +299,14 @@ Common return values are documented :ref:`here `, the foll
* - .. raw:: html
- |