From d2b99090b4b671846271f794316e171d46c2770f Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Wed, 30 Aug 2023 06:32:39 +0200 Subject: [PATCH 1/3] Improve logical information for labels to Ansible objects. --- src/antsibull_docs/augment_docs.py | 26 +- .../ansible-docsite/macros/attributes.rst.j2 | 16 +- .../ansible-docsite/macros/parameters.rst.j2 | 38 ++- .../macros/returnvalues.rst.j2 | 31 +- .../ansible-docsite/plugin-error.rst.j2 | 4 + .../ansible-docsite/plugin-redirect.rst.j2 | 5 + .../ansible-docsite/plugin-tombstone.rst.j2 | 5 + .../docsite/ansible-docsite/plugin.rst.j2 | 8 + .../data/docsite/ansible-docsite/role.rst.j2 | 20 +- .../simplified-rst/macros/parameters.rst.j2 | 8 +- .../simplified-rst/macros/returnvalues.rst.j2 | 4 +- .../data/docsite/simplified-rst/role.rst.j2 | 2 +- src/sphinx_antsibull_ext/directive_helper.py | 6 +- src/sphinx_antsibull_ext/directives.py | 295 +++++++++++++++++- src/sphinx_antsibull_ext/nodes.py | 36 +++ .../schemas/ansible_plugin.py | 51 +++ .../collections/ns/col2/bar_role.rst | 18 ++ .../collections/ns/col2/foo2_module.rst | 134 ++++---- .../collections/ns/col2/foo3_module.rst | 105 +++---- .../collections/ns/col2/foo4_module.rst | 66 ++-- .../collections/ns/col2/foo_module.rst | 4 + .../collections/ns2/col/bar_filter.rst | 80 +++-- .../collections/ns2/col/bar_test.rst | 35 ++- .../collections/ns2/col/foo2_module.rst | 87 +++--- .../collections/ns2/col/foo_become.rst | 51 ++- .../collections/ns2/col/foo_cache.rst | 36 +-- .../collections/ns2/col/foo_callback.rst | 21 +- .../collections/ns2/col/foo_cliconf.rst | 6 + .../collections/ns2/col/foo_connection.rst | 36 +-- .../collections/ns2/col/foo_filter.rst | 65 ++-- .../collections/ns2/col/foo_inventory.rst | 21 +- .../collections/ns2/col/foo_lookup.rst | 50 +-- .../collections/ns2/col/foo_module.rst | 135 ++++---- .../ns2/col/foo_redirect_module.rst | 5 + .../collections/ns2/col/foo_role.rst | 72 ++--- .../collections/ns2/col/foo_shell.rst | 36 +-- .../collections/ns2/col/foo_strategy.rst | 6 + .../collections/ns2/col/foo_test.rst | 50 +-- .../collections/ns2/col/foo_vars.rst | 36 +-- .../collections/ns2/col/is_bar_test.rst | 5 + .../collections/ns2/col/sub.foo3_module.rst | 87 +++--- .../collections/ns2/flatcol/foo2_module.rst | 35 ++- .../collections/ns2/flatcol/foo_module.rst | 95 +++--- .../collections/ns/col2/bar_role.rst | 18 ++ .../collections/ns/col2/foo2_module.rst | 134 ++++---- .../collections/ns/col2/foo3_module.rst | 105 +++---- .../collections/ns/col2/foo4_module.rst | 66 ++-- .../collections/ns/col2/foo_module.rst | 4 + .../collections/ns2/col/bar_filter.rst | 80 +++-- .../collections/ns2/col/bar_test.rst | 35 ++- .../collections/ns2/col/foo2_module.rst | 87 +++--- .../collections/ns2/col/foo_become.rst | 51 ++- .../collections/ns2/col/foo_cache.rst | 36 +-- .../collections/ns2/col/foo_callback.rst | 21 +- .../collections/ns2/col/foo_cliconf.rst | 6 + .../collections/ns2/col/foo_connection.rst | 36 +-- .../collections/ns2/col/foo_filter.rst | 65 ++-- .../collections/ns2/col/foo_inventory.rst | 21 +- .../collections/ns2/col/foo_lookup.rst | 50 +-- .../collections/ns2/col/foo_module.rst | 135 ++++---- .../ns2/col/foo_redirect_module.rst | 5 + .../collections/ns2/col/foo_role.rst | 72 ++--- .../collections/ns2/col/foo_shell.rst | 36 +-- .../collections/ns2/col/foo_strategy.rst | 6 + .../collections/ns2/col/foo_test.rst | 50 +-- .../collections/ns2/col/foo_vars.rst | 36 +-- .../collections/ns2/col/is_bar_test.rst | 5 + .../collections/ns2/col/sub.foo3_module.rst | 87 +++--- .../collections/ns2/flatcol/foo2_module.rst | 35 ++- .../collections/ns2/flatcol/foo_module.rst | 95 +++--- .../collections/ns2/col/bar_filter.rst | 80 +++-- .../collections/ns2/col/bar_test.rst | 35 ++- .../collections/ns2/col/foo2_module.rst | 87 +++--- .../collections/ns2/col/foo_become.rst | 51 ++- .../collections/ns2/col/foo_cache.rst | 36 +-- .../collections/ns2/col/foo_callback.rst | 21 +- .../collections/ns2/col/foo_cliconf.rst | 6 + .../collections/ns2/col/foo_connection.rst | 36 +-- .../collections/ns2/col/foo_filter.rst | 65 ++-- .../collections/ns2/col/foo_inventory.rst | 21 +- .../collections/ns2/col/foo_lookup.rst | 50 +-- .../collections/ns2/col/foo_module.rst | 135 ++++---- .../ns2/col/foo_redirect_module.rst | 5 + .../collections/ns2/col/foo_role.rst | 72 ++--- .../collections/ns2/col/foo_shell.rst | 36 +-- .../collections/ns2/col/foo_strategy.rst | 6 + .../collections/ns2/col/foo_test.rst | 50 +-- .../collections/ns2/col/foo_vars.rst | 36 +-- .../collections/ns2/col/is_bar_test.rst | 5 + .../collections/ns2/col/sub.foo3_module.rst | 87 +++--- .../collections/ns2/flatcol/foo2_module.rst | 35 ++- .../collections/ns2/flatcol/foo_module.rst | 95 +++--- .../bar_filter.rst | 28 +- .../bar_test.rst | 10 +- .../foo2_module.rst | 10 +- .../foo_become.rst | 18 +- .../foo_cache.rst | 12 +- .../foo_callback.rst | 6 +- .../foo_connection.rst | 12 +- .../foo_filter.rst | 22 +- .../foo_inventory.rst | 6 +- .../foo_lookup.rst | 16 +- .../foo_module.rst | 30 +- .../foo_role.rst | 12 +- .../foo_shell.rst | 12 +- .../foo_test.rst | 16 +- .../foo_vars.rst | 12 +- .../sub.foo3_module.rst | 10 +- .../collections/ns/col2/foo2_module.rst | 34 +- .../collections/ns/col2/foo3_module.rst | 24 +- .../collections/ns/col2/foo4_module.rst | 24 +- .../collections/ns2/col/bar_filter.rst | 28 +- .../collections/ns2/col/bar_test.rst | 10 +- .../collections/ns2/col/foo2_module.rst | 10 +- .../collections/ns2/col/foo_become.rst | 18 +- .../collections/ns2/col/foo_cache.rst | 12 +- .../collections/ns2/col/foo_callback.rst | 6 +- .../collections/ns2/col/foo_connection.rst | 12 +- .../collections/ns2/col/foo_filter.rst | 22 +- .../collections/ns2/col/foo_inventory.rst | 6 +- .../collections/ns2/col/foo_lookup.rst | 16 +- .../collections/ns2/col/foo_module.rst | 30 +- .../collections/ns2/col/foo_role.rst | 12 +- .../collections/ns2/col/foo_shell.rst | 12 +- .../collections/ns2/col/foo_test.rst | 16 +- .../collections/ns2/col/foo_vars.rst | 12 +- .../collections/ns2/col/sub.foo3_module.rst | 10 +- .../collections/ns2/flatcol/foo2_module.rst | 10 +- .../collections/ns2/flatcol/foo_module.rst | 38 +-- .../baseline-squash-hierarchy/bar_filter.rst | 80 +++-- .../baseline-squash-hierarchy/bar_test.rst | 35 ++- .../baseline-squash-hierarchy/foo2_module.rst | 87 +++--- .../baseline-squash-hierarchy/foo_become.rst | 51 ++- .../baseline-squash-hierarchy/foo_cache.rst | 36 +-- .../foo_callback.rst | 21 +- .../baseline-squash-hierarchy/foo_cliconf.rst | 6 + .../foo_connection.rst | 36 +-- .../baseline-squash-hierarchy/foo_filter.rst | 65 ++-- .../foo_inventory.rst | 21 +- .../baseline-squash-hierarchy/foo_lookup.rst | 50 +-- .../baseline-squash-hierarchy/foo_module.rst | 135 ++++---- .../foo_redirect_module.rst | 5 + .../baseline-squash-hierarchy/foo_role.rst | 72 ++--- .../baseline-squash-hierarchy/foo_shell.rst | 36 +-- .../foo_strategy.rst | 6 + .../baseline-squash-hierarchy/foo_test.rst | 50 +-- .../baseline-squash-hierarchy/foo_vars.rst | 36 +-- .../baseline-squash-hierarchy/is_bar_test.rst | 5 + .../sub.foo3_module.rst | 87 +++--- .../collections/ns2/col/bar_filter.rst | 32 +- .../collections/ns2/col/bar_test.rst | 14 +- .../collections/ns2/col/foo2_module.rst | 66 ++-- .../collections/ns2/col/foo_become.rst | 24 +- .../collections/ns2/col/foo_cache.rst | 18 +- .../collections/ns2/col/foo_callback.rst | 12 +- .../collections/ns2/col/foo_cliconf.rst | 6 + .../collections/ns2/col/foo_connection.rst | 18 +- .../collections/ns2/col/foo_filter.rst | 26 +- .../collections/ns2/col/foo_inventory.rst | 12 +- .../collections/ns2/col/foo_lookup.rst | 20 +- .../collections/ns2/col/foo_module.rst | 86 +++-- .../ns2/col/foo_redirect_module.rst | 5 + .../collections/ns2/col/foo_role.rst | 52 +-- .../collections/ns2/col/foo_shell.rst | 18 +- .../collections/ns2/col/foo_strategy.rst | 6 + .../collections/ns2/col/foo_test.rst | 20 +- .../collections/ns2/col/foo_vars.rst | 18 +- .../collections/ns2/col/is_bar_test.rst | 5 + .../collections/ns2/col/sub.foo3_module.rst | 66 ++-- tests/functional/build-docs-baseline.sh | 2 +- 170 files changed, 3302 insertions(+), 3097 deletions(-) create mode 100644 src/sphinx_antsibull_ext/schemas/ansible_plugin.py diff --git a/src/antsibull_docs/augment_docs.py b/src/antsibull_docs/augment_docs.py index fdcd1eb3..dce6e661 100644 --- a/src/antsibull_docs/augment_docs.py +++ b/src/antsibull_docs/augment_docs.py @@ -12,13 +12,11 @@ from collections.abc import Mapping, MutableMapping from .docs_parsing.routing import CollectionRoutingT -from .utils.rst import massage_rst_label -def add_full_key( +def add_full_keys( options_data: Mapping[str, t.Any], suboption_entry: str, - _full_key: list[str] | None = None, _full_keys: list[list[str]] | None = None, ) -> None: """ @@ -28,13 +26,11 @@ def add_full_key( a deeply nested structure, for instance.) They describe each entry into the dict. When constructing documentation which uses that, it can be useful to know the hierarchy leads to that entry (for instance, to make a target for an html href). This function adds that - information to a ``full_key`` field on the suboptions' entry. + information to a ``full_keys`` field on the suboptions' entry. :arg options_data: The documentation data which is going to be analyzed and updated. :arg suboption_entry: The name of the suboptions key in the data. For options data, this is ``suboptions``. For returndocs, it is ``contains``. - :kwarg _full_key: This is a recursive function. After we pass the first level of nesting, - ``_full_key`` is set to record the names of the upper levels of the hierarchy. :kwarg _full_keys: This is a recursive function. After we pass the first level of nesting, ``_full_keys`` is a list of sets to record the names of the upper levels of the hierarchy, including all aliases for all names involved. @@ -42,31 +38,23 @@ def add_full_key( .. warning:: This function operates by side-effect. The options_data dictionay is modified directly. """ - if _full_key is None: - _full_key = [] if _full_keys is None: _full_keys = [[]] for key, entry in options_data.items(): # Make sure that "full key" is contained - full_key_k = _full_key + [key] full_keys_k = [fk + [key] for fk in _full_keys] if "aliases" in entry: for alias in entry["aliases"]: full_keys_k.extend([fk + [alias] for fk in _full_keys]) - entry["full_key"] = full_key_k entry["full_keys"] = full_keys_k - entry["full_keys_rst"] = sorted( - {tuple(massage_rst_label(p) for p in fk) for fk in full_keys_k} - ) # Process suboptions suboptions = entry.get(suboption_entry) if suboptions: - add_full_key( + add_full_keys( suboptions, suboption_entry=suboption_entry, - _full_key=full_key_k, _full_keys=full_keys_k, ) @@ -126,7 +114,7 @@ def augment_docs( The additional data is calculated from the existing data and then added to the data. Current Augmentations: - * ``full_key`` allows displaying nested suboptions and return dicts. + * ``full_keys`` allows displaying nested suboptions and return dicts. * In see-alsos that reference to modules or plugins but that have no description, automatically insert the destination's short_description (if available) @@ -145,9 +133,9 @@ def augment_docs( # Now augment all plugin records for plugin_name, plugin_record in plugin_map.items(): if plugin_record.get("return"): - add_full_key(plugin_record["return"], "contains") + add_full_keys(plugin_record["return"], "contains") if plugin_record.get("doc"): - add_full_key(plugin_record["doc"]["options"], "suboptions") + add_full_keys(plugin_record["doc"]["options"], "suboptions") if plugin_record["doc"].get("seealso"): _add_seealso(plugin_record["doc"]["seealso"], plugin_info) _add_aliases( @@ -155,4 +143,4 @@ def augment_docs( ) if plugin_record.get("entry_points"): for entry_point in plugin_record["entry_points"].values(): - add_full_key(entry_point["options"], "options") + add_full_keys(entry_point["options"], "options") diff --git a/src/antsibull_docs/data/docsite/ansible-docsite/macros/attributes.rst.j2 b/src/antsibull_docs/data/docsite/ansible-docsite/macros/attributes.rst.j2 index 1b7b8254..a0d967de 100644 --- a/src/antsibull_docs/data/docsite/ansible-docsite/macros/attributes.rst.j2 +++ b/src/antsibull_docs/data/docsite/ansible-docsite/macros/attributes.rst.j2 @@ -24,17 +24,15 @@ * - .. raw:: html
-
- .. _@{ rst_attribute_ref(plugin_name, plugin_type, role_entrypoint=role_entrypoint, attribute=attribute) }@: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **@{ attribute }@** - - .. raw:: html - - + fqcn: @{ plugin_name }@ + plugin_type: @{ plugin_type }@ +{% if role_entrypoint is not none %} + role_entrypoint: @{ role_entrypoint | antsibull_to_json }@ +{% endif %} + name: @{ attribute | antsibull_to_json }@ .. raw:: html diff --git a/src/antsibull_docs/data/docsite/ansible-docsite/macros/parameters.rst.j2 b/src/antsibull_docs/data/docsite/ansible-docsite/macros/parameters.rst.j2 index f1d93058..afa4525d 100644 --- a/src/antsibull_docs/data/docsite/ansible-docsite/macros/parameters.rst.j2 +++ b/src/antsibull_docs/data/docsite/ansible-docsite/macros/parameters.rst.j2 @@ -10,7 +10,7 @@ {% from 'macros/deprecates.rst.j2' import in_html as deprecates_html with context %} {% from 'macros/version_added.rst.j2' import version_added_rst, version_added_html %} -{% macro in_rst(elements, suboption_key='suboptions', parameter_html_prefix='', role_entrypoint=None) %} +{% macro in_rst(elements, suboption_key='suboptions', role_entrypoint=None) %} .. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: @@ -27,27 +27,25 @@ * - .. raw:: html {% for i in range(1, loop.depth) %}
{% endfor %}
-{% for full_key in value['full_keys'] %} -
-{% endfor %} -{% if loop.depth > 1 %} +{% if loop.depth > 1 %} .. raw:: latex \hspace{@{ 0.02 * loop.depth0 }@\textwidth}\begin{minipage}[t]{@{ 0.32 - 0.02 * loop.depth0 }@\textwidth} -{% endif %} - -{% for full_key in value['full_keys_rst'] %} - .. _@{ rst_option_ref(plugin_name, plugin_type, role_entrypoint=role_entrypoint, option=full_key) }@: -{% endfor %} - - .. rst-class:: ansible-option-title - - **@{ key }@** +{% endif %} - .. raw:: html + .. ansible-option:: - + fqcn: @{ plugin_name }@ + plugin_type: @{ plugin_type }@ +{% if role_entrypoint is not none %} + role_entrypoint: @{ role_entrypoint | antsibull_to_json }@ +{% endif %} + name: @{ key | antsibull_to_json }@ + full_keys: +{% for full_key in value['full_keys'] %} + - @{ full_key | antsibull_to_json }@ +{% endfor %} .. ansible-option-type-line:: {% if value['aliases'] %} @@ -180,7 +178,7 @@ {##################################################################################################################} -{% macro in_html(elements, suboption_key='suboptions', parameter_html_prefix='', role_entrypoint=None) %} +{% macro in_html(elements, suboption_key='suboptions', role_entrypoint=None) %} .. raw:: html @@ -197,10 +195,10 @@
{% for i in range(1, loop.depth) %}
{% endfor %}
{% 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/ansible-docsite/macros/returnvalues.rst.j2 b/src/antsibull_docs/data/docsite/ansible-docsite/macros/returnvalues.rst.j2 index c94a34ff..5122ef37 100644 --- a/src/antsibull_docs/data/docsite/ansible-docsite/macros/returnvalues.rst.j2 +++ b/src/antsibull_docs/data/docsite/ansible-docsite/macros/returnvalues.rst.j2 @@ -25,27 +25,28 @@ * - .. raw:: html {% for i in range(1, loop.depth) %}
{% endfor %}
-{% for full_key in value['full_keys'] %} -
-{% endfor %} -{% if loop.depth > 1 %} +{% if loop.depth > 1 %} .. raw:: latex \hspace{@{ 0.02 * loop.depth0 }@\textwidth}\begin{minipage}[t]{@{ 0.32 - 0.02 * loop.depth0 }@\textwidth} -{% endif %} - -{% for full_key in value['full_keys_rst'] %} - .. _@{ rst_return_value_ref(plugin_name, plugin_type, role_entrypoint=role_entrypoint, return_value=full_key) }@: -{% endfor %} +{% endif %} - .. rst-class:: ansible-option-title + .. ansible-return-value:: - **@{ key }@** + fqcn: @{ plugin_name }@ + plugin_type: @{ plugin_type }@ +{% if role_entrypoint is not none %} + role_entrypoint: @{ role_entrypoint | antsibull_to_json }@ +{% endif %} + name: @{ key | antsibull_to_json }@ + full_keys: +{% for full_key in value['full_keys'] %} + - @{ full_key | antsibull_to_json }@ +{% endfor %} .. raw:: html - - + :url: data:text/plain;base64,IA== .. ansible-option-type-line:: @@ -132,8 +133,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/ansible-docsite/plugin-error.rst.j2 b/src/antsibull_docs/data/docsite/ansible-docsite/plugin-error.rst.j2 index bcd7e511..7ecc2645 100644 --- a/src/antsibull_docs/data/docsite/ansible-docsite/plugin-error.rst.j2 +++ b/src/antsibull_docs/data/docsite/ansible-docsite/plugin-error.rst.j2 @@ -27,6 +27,10 @@ @{ title }@ @{ '+' * title|column_width }@ +.. ansible-plugin:: + + fqcn: @{ plugin_name }@ + plugin_type: @{ plugin_type }@ The documentation for the @{ plugin_type }@ plugin, @{ plugin_name }@, was malformed. diff --git a/src/antsibull_docs/data/docsite/ansible-docsite/plugin-redirect.rst.j2 b/src/antsibull_docs/data/docsite/ansible-docsite/plugin-redirect.rst.j2 index 23322986..ccf3faed 100644 --- a/src/antsibull_docs/data/docsite/ansible-docsite/plugin-redirect.rst.j2 +++ b/src/antsibull_docs/data/docsite/ansible-docsite/plugin-redirect.rst.j2 @@ -22,6 +22,11 @@ @{ title }@ @{ '+' * title|column_width }@ +.. ansible-plugin:: + + fqcn: @{ plugin_name }@ + plugin_type: @{ plugin_type }@ + .. Collection note {% if collection == 'ansible.builtin' -%} diff --git a/src/antsibull_docs/data/docsite/ansible-docsite/plugin-tombstone.rst.j2 b/src/antsibull_docs/data/docsite/ansible-docsite/plugin-tombstone.rst.j2 index 9a3192ab..f3cf44ea 100644 --- a/src/antsibull_docs/data/docsite/ansible-docsite/plugin-tombstone.rst.j2 +++ b/src/antsibull_docs/data/docsite/ansible-docsite/plugin-tombstone.rst.j2 @@ -20,6 +20,11 @@ @{ plugin_name }@ @{ '+' * plugin_name|column_width }@ +.. ansible-plugin:: + + fqcn: @{ plugin_name }@ + plugin_type: @{ plugin_type }@ + .. Collection note {% if collection == 'ansible.builtin' -%} diff --git a/src/antsibull_docs/data/docsite/ansible-docsite/plugin.rst.j2 b/src/antsibull_docs/data/docsite/ansible-docsite/plugin.rst.j2 index 086618c4..78565420 100644 --- a/src/antsibull_docs/data/docsite/ansible-docsite/plugin.rst.j2 +++ b/src/antsibull_docs/data/docsite/ansible-docsite/plugin.rst.j2 @@ -50,6 +50,14 @@ @{ title }@ @{ '+' * title|column_width }@ +.. ansible-plugin:: + + fqcn: @{ plugin_name }@ + plugin_type: @{ plugin_type }@ +{% if doc['short_description'] %} + short_description: @{ doc['short_description'] | rst_ify | antsibull_to_json }@ +{% endif %} + .. Collection note {% if collection == 'ansible.builtin' -%} diff --git a/src/antsibull_docs/data/docsite/ansible-docsite/role.rst.j2 b/src/antsibull_docs/data/docsite/ansible-docsite/role.rst.j2 index 6761b028..59b96e37 100644 --- a/src/antsibull_docs/data/docsite/ansible-docsite/role.rst.j2 +++ b/src/antsibull_docs/data/docsite/ansible-docsite/role.rst.j2 @@ -38,6 +38,14 @@ @{ title }@ @{ '+' * title|column_width }@ +.. ansible-plugin:: + + fqcn: @{ plugin_name }@ + plugin_type: @{ plugin_type }@ +{% if entry_points.main and entry_points.main.short_description %} + short_description: @{ entry_points.main.short_description | rst_ify(role_entrypoint='main') | antsibull_to_json }@ +{% endif %} + .. Collection note {% if collection == 'ansible.builtin' -%} @@ -76,6 +84,14 @@ @{ title }@ @{ '-' * title|column_width }@ +.. ansible-role-entrypoint:: + + fqcn: @{ plugin_name }@ + entrypoint: @{ entry_point }@ +{% if ep_doc['short_description'] %} + short_description: @{ ep_doc['short_description'] | rst_ify(role_entrypoint=entry_point) | antsibull_to_json }@ +{% endif %} + .. version_added {% if ep_doc['version_added'] is still_relevant(collection=collection) -%} @@ -130,9 +146,9 @@ Parameters ^^^^^^^^^^ {% if use_html_blobs %} -@{ 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) }@ {% else %} -@{ parameters_rst(ep_doc['options'] | dictsort, suboption_key='options', parameter_html_prefix=entry_point ~ '--', role_entrypoint=entry_point) }@ +@{ parameters_rst(ep_doc['options'] | dictsort, suboption_key='options', role_entrypoint=entry_point) }@ {% endif %} {% endif %} diff --git a/src/antsibull_docs/data/docsite/simplified-rst/macros/parameters.rst.j2 b/src/antsibull_docs/data/docsite/simplified-rst/macros/parameters.rst.j2 index e830bab6..139e64f0 100644 --- a/src/antsibull_docs/data/docsite/simplified-rst/macros/parameters.rst.j2 +++ b/src/antsibull_docs/data/docsite/simplified-rst/macros/parameters.rst.j2 @@ -8,7 +8,7 @@ {% from 'macros/deprecates.rst.j2' import in_html as deprecates_html with context %} {% from 'macros/version_added.rst.j2' import version_added_html %} -{% macro in_html(elements, suboption_key='suboptions', parameter_html_prefix='', role_entrypoint=None) %} +{% macro in_html(elements, suboption_key='suboptions', role_entrypoint=None) %} .. raw:: html @@ -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..c400a64c 100644 --- a/src/sphinx_antsibull_ext/directives.py +++ b/src/sphinx_antsibull_ext/directives.py @@ -9,16 +9,37 @@ 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, + AnsibleReturnValue, + AnsibleRoleEntrypoint, +) + +logger = logging.getLogger(__name__) -class _OptionTypeLine(Directive): +class _OptionTypeLine(SphinxDirective): final_argument_whitespace = True has_content = True @@ -71,9 +92,274 @@ 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 _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] + ) + 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 {content.fqcn} {content.plugin_type}", + ) + 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]], 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)) + 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, + ) + self.state.document.note_explicit_target(node) + std = t.cast(StandardDomain, self.env.get_domain("std")) + for rst_id, (html_id, key) in rst_ids.items(): + std.note_hyperlink_target( + rst_id, + self.env.docname, + html_id, + f"{key} option of {content.fqcn} {content.plugin_type}", + ) + 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, + ) + self.state.document.note_explicit_target(node) + std = t.cast(StandardDomain, self.env.get_domain("std")) + for rst_id, (html_id, key) in rst_ids.items(): + std.note_hyperlink_target( + rst_id, + self.env.docname, + html_id, + f"{key} return value of {content.fqcn} {content.plugin_type}", + ) + 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-attribute": _Attribute, + "ansible-option": _Option, + "ansible-return-value": _ReturnValue, } @@ -81,5 +367,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..59440467 --- /dev/null +++ b/src/sphinx_antsibull_ext/schemas/ansible_plugin.py @@ -0,0 +1,51 @@ +# 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 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]] + + +class AnsibleReturnValue(p.BaseModel): + fqcn: str + plugin_type: str + role_entrypoint: t.Optional[str] = None + name: str + full_keys: list[list[str]] 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..1513c455 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:: @@ -94,17 +100,14 @@ Parameters * - .. raw:: html

-
- - .. _ansible_collections.ns.col2.foo2_module__parameter-bar: - .. rst-class:: ansible-option-title + .. ansible-option:: - **bar** - - .. raw:: html - - + fqcn: ns.col2.foo2 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -130,17 +133,14 @@ Parameters * - .. raw:: html
-
- - .. _ansible_collections.ns.col2.foo2_module__parameter-foo: - - .. rst-class:: ansible-option-title - - **foo** - .. raw:: html + .. ansible-option:: - + fqcn: ns.col2.foo2 + plugin_type: module + name: "foo" + full_keys: + - ["foo"] .. ansible-option-type-line:: @@ -164,17 +164,14 @@ Parameters * - .. raw:: html
-
- - .. _ansible_collections.ns.col2.foo2_module__parameter-subfoo: - - .. rst-class:: ansible-option-title - **subfoo** - - .. raw:: html + .. ansible-option:: - + fqcn: ns.col2.foo2 + plugin_type: module + name: "subfoo" + full_keys: + - ["subfoo"] .. ansible-option-type-line:: @@ -198,21 +195,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 +234,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: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **foo** - - .. raw:: html - - + fqcn: ns.col2.foo2 + plugin_type: module + name: "foo" + full_keys: + - ["subfoo", "foo"] .. ansible-option-type-line:: @@ -308,17 +299,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 +336,12 @@ Attributes * - .. raw:: html
-
- - .. _ansible_collections.ns.col2.foo2_module__attribute-diff_mode: - .. rst-class:: ansible-option-title + .. ansible-attribute:: - **diff_mode** - - .. raw:: html - - + fqcn: ns.col2.foo2 + plugin_type: module + name: "diff_mode" .. raw:: html @@ -392,17 +373,12 @@ Attributes * - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo2_module__attribute-platform: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **platform** - - .. raw:: html - - + fqcn: ns.col2.foo2 + plugin_type: module + name: "platform" .. raw:: html @@ -499,17 +475,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo2_module__return-bar: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **bar** + fqcn: ns.col2.foo2 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..4b5f692c 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:: @@ -89,17 +95,14 @@ Parameters * - .. raw:: html
-
- - .. _ansible_collections.ns.col2.foo3_module__parameter-bar: - - .. rst-class:: ansible-option-title - **bar** + .. ansible-option:: - .. raw:: html - - + fqcn: ns.col2.foo3 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -123,17 +126,14 @@ Parameters * - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo3_module__parameter-foo: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **foo** - - .. raw:: html - - + fqcn: ns.col2.foo3 + plugin_type: module + name: "foo" + full_keys: + - ["foo"] .. ansible-option-type-line:: @@ -157,17 +157,14 @@ Parameters * - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo3_module__parameter-subfoo: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **subfoo** - - .. raw:: html - - + fqcn: ns.col2.foo3 + plugin_type: module + name: "subfoo" + full_keys: + - ["subfoo"] .. ansible-option-type-line:: @@ -191,21 +188,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 + .. ansible-option:: - **foo** - - .. raw:: html - - + fqcn: ns.col2.foo3 + plugin_type: module + name: "foo" + full_keys: + - ["subfoo", "foo"] .. ansible-option-type-line:: @@ -257,17 +251,12 @@ Attributes * - .. raw:: html
-
- - .. _ansible_collections.ns.col2.foo3_module__attribute-check_mode: - .. rst-class:: ansible-option-title + .. ansible-attribute:: - **check_mode** - - .. raw:: html - - + fqcn: ns.col2.foo3 + plugin_type: module + name: "check_mode" .. raw:: html @@ -299,17 +288,12 @@ Attributes * - .. raw:: html
-
- - .. _ansible_collections.ns.col2.foo3_module__attribute-diff_mode: - .. rst-class:: ansible-option-title + .. ansible-attribute:: - **diff_mode** - - .. raw:: html - - + fqcn: ns.col2.foo3 + plugin_type: module + name: "diff_mode" .. raw:: html @@ -341,17 +325,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..812a6fb5 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,14 @@ 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"] .. ansible-option-type-line:: @@ -143,17 +146,14 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)`` * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.bar_filter__parameter-foo: - - .. rst-class:: ansible-option-title - **foo** - - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.bar + plugin_type: filter + name: "foo" + full_keys: + - ["foo"] .. ansible-option-type-line:: @@ -180,17 +180,14 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)`` * - .. raw:: html
-
- .. _ansible_collections.ns2.col.bar_filter__parameter-bar: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html - - + fqcn: ns2.col.bar + plugin_type: filter + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -246,17 +243,14 @@ example: ``input | ns2.col.bar(key1=value1, key2=value2, ...)`` * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.bar_filter__parameter-baz: - .. rst-class:: ansible-option-title + .. ansible-option:: - **baz** - - .. raw:: html - - + fqcn: ns2.col.bar + plugin_type: filter + name: "baz" + full_keys: + - ["baz"] .. ansible-option-type-line:: @@ -351,17 +345,17 @@ Return Value * - .. raw:: html
-
- .. _ansible_collections.ns2.col.bar_filter__return-_value: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **Return value** + fqcn: ns2.col.bar + plugin_type: filter + name: "Return value" + full_keys: + - ["_value"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..f4543b19 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,14 @@ 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** + .. ansible-option:: - .. raw:: html - - + fqcn: ns2.col.bar + plugin_type: test + name: "Input" + full_keys: + - ["_input"] .. ansible-option-type-line:: @@ -165,17 +168,17 @@ Return Value * - .. raw:: html
-
- .. _ansible_collections.ns2.col.bar_test__return-_value: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **Return value** + fqcn: ns2.col.bar + plugin_type: test + name: "Return value" + full_keys: + - ["_value"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..95c8a112 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: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html + .. ansible-option:: - + 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: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **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** + .. ansible-attribute:: - .. raw:: html - - + 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 - - **diff_mode** - - .. raw:: html + .. ansible-attribute:: - + 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: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **platform** - - .. raw:: html - - + fqcn: ns2.col.foo2 + plugin_type: module + name: "platform" .. raw:: html @@ -347,17 +330,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo2_module__return-bar: - .. rst-class:: ansible-option-title + .. ansible-return-value:: - **bar** + fqcn: ns2.col.foo2 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..bd580cf7 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,14 @@ 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 - **Input** + .. ansible-option:: - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: filter + name: "Input" + full_keys: + - ["_input"] .. ansible-option-type-line:: @@ -143,17 +146,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** + .. ansible-option:: - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: filter + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -180,17 +180,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** + .. ansible-option:: - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: filter + name: "foo" + full_keys: + - ["foo"] .. ansible-option-type-line:: @@ -259,17 +256,17 @@ Return Value * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_filter__return-_value: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **Return value** + fqcn: ns2.col.foo + plugin_type: filter + name: "Return value" + full_keys: + - ["_value"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..3ab43d85 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,14 @@ Terms * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_lookup__parameter-_terms: - .. rst-class:: ansible-option-title - - **Terms** - - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: lookup + name: "Terms" + full_keys: + - ["_terms"] .. ansible-option-type-line:: @@ -142,17 +145,14 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query(' * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_lookup__parameter-bar: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: lookup + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -229,17 +229,17 @@ Return Value * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_lookup__return-_raw: - .. rst-class:: ansible-option-title + .. ansible-return-value:: - **Return value** + fqcn: ns2.col.foo + plugin_type: lookup + name: "Return value" + full_keys: + - ["_raw"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..258609ee 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:: @@ -96,19 +102,15 @@ Parameters * - .. raw:: html
-
-
- - .. _ansible_collections.ns2.col.foo_module__parameter-bar: - .. _ansible_collections.ns2.col.foo_module__parameter-baz: - .. rst-class:: ansible-option-title + .. ansible-option:: - **bar** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: module + name: "bar" + full_keys: + - ["bar"] + - ["baz"] .. ansible-option-type-line:: @@ -138,17 +140,14 @@ Parameters * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_module__parameter-foo: - - .. rst-class:: ansible-option-title - - **foo** - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: module + name: "foo" + full_keys: + - ["foo"] .. ansible-option-type-line:: @@ -172,17 +171,14 @@ Parameters * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_module__parameter-subfoo: - - .. rst-class:: ansible-option-title - **subfoo** - - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: module + name: "subfoo" + full_keys: + - ["subfoo"] .. ansible-option-type-line:: @@ -209,21 +205,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 +268,12 @@ Attributes * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_module__attribute-action_group: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **action_group** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: module + name: "action_group" .. raw:: html @@ -317,17 +305,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 +342,12 @@ Attributes * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_module__attribute-diff_mode: - .. rst-class:: ansible-option-title + .. ansible-attribute:: - **diff_mode** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: module + name: "diff_mode" .. raw:: html @@ -401,17 +379,12 @@ Attributes * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_module__attribute-platform: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **platform** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: module + name: "platform" .. raw:: html @@ -504,17 +477,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_module__return-bar: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **bar** + fqcn: ns2.col.foo + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..de21ce8f 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,14 @@ 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: - .. rst-class:: ansible-option-title - - **Input** - - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: test + name: "Input" + full_keys: + - ["_input"] .. ansible-option-type-line:: @@ -140,17 +143,14 @@ examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_test__parameter-bar: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: test + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -219,17 +219,17 @@ Return Value * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_test__return-_value: - .. rst-class:: ansible-option-title + .. ansible-return-value:: - **Return value** + fqcn: ns2.col.foo + plugin_type: test + name: "Return value" + full_keys: + - ["_value"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..9bc202ad 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:: @@ -94,17 +100,14 @@ Parameters * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_vars__parameter-_valid_extensions: - - .. rst-class:: ansible-option-title - - **_valid_extensions** - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: vars + name: "_valid_extensions" + full_keys: + - ["_valid_extensions"] .. ansible-option-type-line:: @@ -150,17 +153,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..b48ab50f 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: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html + .. ansible-option:: - + 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: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **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** + .. ansible-attribute:: - .. raw:: html - - + 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 - - **diff_mode** - - .. raw:: html + .. ansible-attribute:: - + 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: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **platform** - - .. raw:: html - - + fqcn: ns2.col.sub.foo3 + plugin_type: module + name: "platform" .. raw:: html @@ -346,17 +329,17 @@ 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 + .. ansible-return-value:: - **bar** + fqcn: ns2.col.sub.foo3 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..2e3a8e6a 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** + .. ansible-option:: - .. raw:: html - - + fqcn: ns2.flatcol.foo2 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -161,17 +164,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
- .. _ansible_collections.ns2.flatcol.foo2_module__return-bar: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **bar** + fqcn: ns2.flatcol.foo2 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..0389d79c 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: - - .. rst-class:: ansible-option-title - **foo** - - .. raw:: html + .. ansible-option:: - + 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: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **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: - - .. rst-class:: ansible-option-title + .. ansible-option:: - **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,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
- .. _ansible_collections.ns2.flatcol.foo_module__return-bar: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **bar** + fqcn: ns2.flatcol.foo + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..1513c455 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:: @@ -94,17 +100,14 @@ Parameters * - .. raw:: html
-
- - .. _ansible_collections.ns.col2.foo2_module__parameter-bar: - .. rst-class:: ansible-option-title + .. ansible-option:: - **bar** - - .. raw:: html - - + fqcn: ns.col2.foo2 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -130,17 +133,14 @@ Parameters * - .. raw:: html
-
- - .. _ansible_collections.ns.col2.foo2_module__parameter-foo: - - .. rst-class:: ansible-option-title - - **foo** - .. raw:: html + .. ansible-option:: - + fqcn: ns.col2.foo2 + plugin_type: module + name: "foo" + full_keys: + - ["foo"] .. ansible-option-type-line:: @@ -164,17 +164,14 @@ Parameters * - .. raw:: html
-
- - .. _ansible_collections.ns.col2.foo2_module__parameter-subfoo: - - .. rst-class:: ansible-option-title - **subfoo** - - .. raw:: html + .. ansible-option:: - + fqcn: ns.col2.foo2 + plugin_type: module + name: "subfoo" + full_keys: + - ["subfoo"] .. ansible-option-type-line:: @@ -198,21 +195,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 +234,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: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **foo** - - .. raw:: html - - + fqcn: ns.col2.foo2 + plugin_type: module + name: "foo" + full_keys: + - ["subfoo", "foo"] .. ansible-option-type-line:: @@ -308,17 +299,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 +336,12 @@ Attributes * - .. raw:: html
-
- - .. _ansible_collections.ns.col2.foo2_module__attribute-diff_mode: - .. rst-class:: ansible-option-title + .. ansible-attribute:: - **diff_mode** - - .. raw:: html - - + fqcn: ns.col2.foo2 + plugin_type: module + name: "diff_mode" .. raw:: html @@ -392,17 +373,12 @@ Attributes * - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo2_module__attribute-platform: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **platform** - - .. raw:: html - - + fqcn: ns.col2.foo2 + plugin_type: module + name: "platform" .. raw:: html @@ -499,17 +475,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo2_module__return-bar: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **bar** + fqcn: ns.col2.foo2 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..4b5f692c 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:: @@ -89,17 +95,14 @@ Parameters * - .. raw:: html
-
- - .. _ansible_collections.ns.col2.foo3_module__parameter-bar: - - .. rst-class:: ansible-option-title - **bar** + .. ansible-option:: - .. raw:: html - - + fqcn: ns.col2.foo3 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -123,17 +126,14 @@ Parameters * - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo3_module__parameter-foo: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **foo** - - .. raw:: html - - + fqcn: ns.col2.foo3 + plugin_type: module + name: "foo" + full_keys: + - ["foo"] .. ansible-option-type-line:: @@ -157,17 +157,14 @@ Parameters * - .. raw:: html
-
- .. _ansible_collections.ns.col2.foo3_module__parameter-subfoo: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **subfoo** - - .. raw:: html - - + fqcn: ns.col2.foo3 + plugin_type: module + name: "subfoo" + full_keys: + - ["subfoo"] .. ansible-option-type-line:: @@ -191,21 +188,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 + .. ansible-option:: - **foo** - - .. raw:: html - - + fqcn: ns.col2.foo3 + plugin_type: module + name: "foo" + full_keys: + - ["subfoo", "foo"] .. ansible-option-type-line:: @@ -257,17 +251,12 @@ Attributes * - .. raw:: html
-
- - .. _ansible_collections.ns.col2.foo3_module__attribute-check_mode: - .. rst-class:: ansible-option-title + .. ansible-attribute:: - **check_mode** - - .. raw:: html - - + fqcn: ns.col2.foo3 + plugin_type: module + name: "check_mode" .. raw:: html @@ -299,17 +288,12 @@ Attributes * - .. raw:: html
-
- - .. _ansible_collections.ns.col2.foo3_module__attribute-diff_mode: - .. rst-class:: ansible-option-title + .. ansible-attribute:: - **diff_mode** - - .. raw:: html - - + fqcn: ns.col2.foo3 + plugin_type: module + name: "diff_mode" .. raw:: html @@ -341,17 +325,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..812a6fb5 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,14 @@ 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"] .. ansible-option-type-line:: @@ -143,17 +146,14 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)`` * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.bar_filter__parameter-foo: - - .. rst-class:: ansible-option-title - **foo** - - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.bar + plugin_type: filter + name: "foo" + full_keys: + - ["foo"] .. ansible-option-type-line:: @@ -180,17 +180,14 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)`` * - .. raw:: html
-
- .. _ansible_collections.ns2.col.bar_filter__parameter-bar: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html - - + fqcn: ns2.col.bar + plugin_type: filter + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -246,17 +243,14 @@ example: ``input | ns2.col.bar(key1=value1, key2=value2, ...)`` * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.bar_filter__parameter-baz: - .. rst-class:: ansible-option-title + .. ansible-option:: - **baz** - - .. raw:: html - - + fqcn: ns2.col.bar + plugin_type: filter + name: "baz" + full_keys: + - ["baz"] .. ansible-option-type-line:: @@ -351,17 +345,17 @@ Return Value * - .. raw:: html
-
- .. _ansible_collections.ns2.col.bar_filter__return-_value: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **Return value** + fqcn: ns2.col.bar + plugin_type: filter + name: "Return value" + full_keys: + - ["_value"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..f4543b19 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,14 @@ 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** + .. ansible-option:: - .. raw:: html - - + fqcn: ns2.col.bar + plugin_type: test + name: "Input" + full_keys: + - ["_input"] .. ansible-option-type-line:: @@ -165,17 +168,17 @@ Return Value * - .. raw:: html
-
- .. _ansible_collections.ns2.col.bar_test__return-_value: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **Return value** + fqcn: ns2.col.bar + plugin_type: test + name: "Return value" + full_keys: + - ["_value"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..95c8a112 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: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html + .. ansible-option:: - + 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: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **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** + .. ansible-attribute:: - .. raw:: html - - + 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 - - **diff_mode** - - .. raw:: html + .. ansible-attribute:: - + 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: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **platform** - - .. raw:: html - - + fqcn: ns2.col.foo2 + plugin_type: module + name: "platform" .. raw:: html @@ -347,17 +330,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo2_module__return-bar: - .. rst-class:: ansible-option-title + .. ansible-return-value:: - **bar** + fqcn: ns2.col.foo2 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..bd580cf7 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,14 @@ 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 - **Input** + .. ansible-option:: - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: filter + name: "Input" + full_keys: + - ["_input"] .. ansible-option-type-line:: @@ -143,17 +146,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** + .. ansible-option:: - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: filter + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -180,17 +180,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** + .. ansible-option:: - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: filter + name: "foo" + full_keys: + - ["foo"] .. ansible-option-type-line:: @@ -259,17 +256,17 @@ Return Value * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_filter__return-_value: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **Return value** + fqcn: ns2.col.foo + plugin_type: filter + name: "Return value" + full_keys: + - ["_value"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..3ab43d85 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,14 @@ Terms * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_lookup__parameter-_terms: - .. rst-class:: ansible-option-title - - **Terms** - - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: lookup + name: "Terms" + full_keys: + - ["_terms"] .. ansible-option-type-line:: @@ -142,17 +145,14 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query(' * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_lookup__parameter-bar: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: lookup + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -229,17 +229,17 @@ Return Value * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_lookup__return-_raw: - .. rst-class:: ansible-option-title + .. ansible-return-value:: - **Return value** + fqcn: ns2.col.foo + plugin_type: lookup + name: "Return value" + full_keys: + - ["_raw"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..258609ee 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:: @@ -96,19 +102,15 @@ Parameters * - .. raw:: html
-
-
- - .. _ansible_collections.ns2.col.foo_module__parameter-bar: - .. _ansible_collections.ns2.col.foo_module__parameter-baz: - .. rst-class:: ansible-option-title + .. ansible-option:: - **bar** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: module + name: "bar" + full_keys: + - ["bar"] + - ["baz"] .. ansible-option-type-line:: @@ -138,17 +140,14 @@ Parameters * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_module__parameter-foo: - - .. rst-class:: ansible-option-title - - **foo** - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: module + name: "foo" + full_keys: + - ["foo"] .. ansible-option-type-line:: @@ -172,17 +171,14 @@ Parameters * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_module__parameter-subfoo: - - .. rst-class:: ansible-option-title - **subfoo** - - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: module + name: "subfoo" + full_keys: + - ["subfoo"] .. ansible-option-type-line:: @@ -209,21 +205,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 +268,12 @@ Attributes * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_module__attribute-action_group: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **action_group** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: module + name: "action_group" .. raw:: html @@ -317,17 +305,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 +342,12 @@ Attributes * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_module__attribute-diff_mode: - .. rst-class:: ansible-option-title + .. ansible-attribute:: - **diff_mode** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: module + name: "diff_mode" .. raw:: html @@ -401,17 +379,12 @@ Attributes * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_module__attribute-platform: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **platform** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: module + name: "platform" .. raw:: html @@ -504,17 +477,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_module__return-bar: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **bar** + fqcn: ns2.col.foo + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..de21ce8f 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,14 @@ 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: - .. rst-class:: ansible-option-title - - **Input** - - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: test + name: "Input" + full_keys: + - ["_input"] .. ansible-option-type-line:: @@ -140,17 +143,14 @@ examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_test__parameter-bar: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: test + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -219,17 +219,17 @@ Return Value * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_test__return-_value: - .. rst-class:: ansible-option-title + .. ansible-return-value:: - **Return value** + fqcn: ns2.col.foo + plugin_type: test + name: "Return value" + full_keys: + - ["_value"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..9bc202ad 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:: @@ -94,17 +100,14 @@ Parameters * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_vars__parameter-_valid_extensions: - - .. rst-class:: ansible-option-title - - **_valid_extensions** - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: vars + name: "_valid_extensions" + full_keys: + - ["_valid_extensions"] .. ansible-option-type-line:: @@ -150,17 +153,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..b48ab50f 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: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html + .. ansible-option:: - + 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: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **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** + .. ansible-attribute:: - .. raw:: html - - + 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 - - **diff_mode** - - .. raw:: html + .. ansible-attribute:: - + 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: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **platform** - - .. raw:: html - - + fqcn: ns2.col.sub.foo3 + plugin_type: module + name: "platform" .. raw:: html @@ -346,17 +329,17 @@ 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 + .. ansible-return-value:: - **bar** + fqcn: ns2.col.sub.foo3 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..2e3a8e6a 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** + .. ansible-option:: - .. raw:: html - - + fqcn: ns2.flatcol.foo2 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -161,17 +164,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
- .. _ansible_collections.ns2.flatcol.foo2_module__return-bar: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **bar** + fqcn: ns2.flatcol.foo2 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..0389d79c 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: - - .. rst-class:: ansible-option-title - **foo** - - .. raw:: html + .. ansible-option:: - + 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: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **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: - - .. rst-class:: ansible-option-title + .. ansible-option:: - **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,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
- .. _ansible_collections.ns2.flatcol.foo_module__return-bar: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **bar** + fqcn: ns2.flatcol.foo + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..812a6fb5 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,14 @@ 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"] .. ansible-option-type-line:: @@ -143,17 +146,14 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)`` * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.bar_filter__parameter-foo: - - .. rst-class:: ansible-option-title - **foo** - - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.bar + plugin_type: filter + name: "foo" + full_keys: + - ["foo"] .. ansible-option-type-line:: @@ -180,17 +180,14 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)`` * - .. raw:: html
-
- .. _ansible_collections.ns2.col.bar_filter__parameter-bar: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html - - + fqcn: ns2.col.bar + plugin_type: filter + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -246,17 +243,14 @@ example: ``input | ns2.col.bar(key1=value1, key2=value2, ...)`` * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.bar_filter__parameter-baz: - .. rst-class:: ansible-option-title + .. ansible-option:: - **baz** - - .. raw:: html - - + fqcn: ns2.col.bar + plugin_type: filter + name: "baz" + full_keys: + - ["baz"] .. ansible-option-type-line:: @@ -351,17 +345,17 @@ Return Value * - .. raw:: html
-
- .. _ansible_collections.ns2.col.bar_filter__return-_value: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **Return value** + fqcn: ns2.col.bar + plugin_type: filter + name: "Return value" + full_keys: + - ["_value"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..f4543b19 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,14 @@ 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** + .. ansible-option:: - .. raw:: html - - + fqcn: ns2.col.bar + plugin_type: test + name: "Input" + full_keys: + - ["_input"] .. ansible-option-type-line:: @@ -165,17 +168,17 @@ Return Value * - .. raw:: html
-
- .. _ansible_collections.ns2.col.bar_test__return-_value: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **Return value** + fqcn: ns2.col.bar + plugin_type: test + name: "Return value" + full_keys: + - ["_value"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..95c8a112 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: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html + .. ansible-option:: - + 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: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **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** + .. ansible-attribute:: - .. raw:: html - - + 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 - - **diff_mode** - - .. raw:: html + .. ansible-attribute:: - + 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: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **platform** - - .. raw:: html - - + fqcn: ns2.col.foo2 + plugin_type: module + name: "platform" .. raw:: html @@ -347,17 +330,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo2_module__return-bar: - .. rst-class:: ansible-option-title + .. ansible-return-value:: - **bar** + fqcn: ns2.col.foo2 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..bd580cf7 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,14 @@ 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 - **Input** + .. ansible-option:: - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: filter + name: "Input" + full_keys: + - ["_input"] .. ansible-option-type-line:: @@ -143,17 +146,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** + .. ansible-option:: - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: filter + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -180,17 +180,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** + .. ansible-option:: - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: filter + name: "foo" + full_keys: + - ["foo"] .. ansible-option-type-line:: @@ -259,17 +256,17 @@ Return Value * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_filter__return-_value: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **Return value** + fqcn: ns2.col.foo + plugin_type: filter + name: "Return value" + full_keys: + - ["_value"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..3ab43d85 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,14 @@ Terms * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_lookup__parameter-_terms: - .. rst-class:: ansible-option-title - - **Terms** - - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: lookup + name: "Terms" + full_keys: + - ["_terms"] .. ansible-option-type-line:: @@ -142,17 +145,14 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query(' * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_lookup__parameter-bar: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: lookup + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -229,17 +229,17 @@ Return Value * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_lookup__return-_raw: - .. rst-class:: ansible-option-title + .. ansible-return-value:: - **Return value** + fqcn: ns2.col.foo + plugin_type: lookup + name: "Return value" + full_keys: + - ["_raw"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..258609ee 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:: @@ -96,19 +102,15 @@ Parameters * - .. raw:: html
-
-
- - .. _ansible_collections.ns2.col.foo_module__parameter-bar: - .. _ansible_collections.ns2.col.foo_module__parameter-baz: - .. rst-class:: ansible-option-title + .. ansible-option:: - **bar** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: module + name: "bar" + full_keys: + - ["bar"] + - ["baz"] .. ansible-option-type-line:: @@ -138,17 +140,14 @@ Parameters * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_module__parameter-foo: - - .. rst-class:: ansible-option-title - - **foo** - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: module + name: "foo" + full_keys: + - ["foo"] .. ansible-option-type-line:: @@ -172,17 +171,14 @@ Parameters * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_module__parameter-subfoo: - - .. rst-class:: ansible-option-title - **subfoo** - - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: module + name: "subfoo" + full_keys: + - ["subfoo"] .. ansible-option-type-line:: @@ -209,21 +205,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 +268,12 @@ Attributes * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_module__attribute-action_group: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **action_group** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: module + name: "action_group" .. raw:: html @@ -317,17 +305,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 +342,12 @@ Attributes * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_module__attribute-diff_mode: - .. rst-class:: ansible-option-title + .. ansible-attribute:: - **diff_mode** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: module + name: "diff_mode" .. raw:: html @@ -401,17 +379,12 @@ Attributes * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_module__attribute-platform: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **platform** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: module + name: "platform" .. raw:: html @@ -504,17 +477,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_module__return-bar: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **bar** + fqcn: ns2.col.foo + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..de21ce8f 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,14 @@ 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: - .. rst-class:: ansible-option-title - - **Input** - - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: test + name: "Input" + full_keys: + - ["_input"] .. ansible-option-type-line:: @@ -140,17 +143,14 @@ examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_test__parameter-bar: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: test + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -219,17 +219,17 @@ Return Value * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_test__return-_value: - .. rst-class:: ansible-option-title + .. ansible-return-value:: - **Return value** + fqcn: ns2.col.foo + plugin_type: test + name: "Return value" + full_keys: + - ["_value"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..9bc202ad 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:: @@ -94,17 +100,14 @@ Parameters * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_vars__parameter-_valid_extensions: - - .. rst-class:: ansible-option-title - - **_valid_extensions** - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: vars + name: "_valid_extensions" + full_keys: + - ["_valid_extensions"] .. ansible-option-type-line:: @@ -150,17 +153,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..b48ab50f 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: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html + .. ansible-option:: - + 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: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **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** + .. ansible-attribute:: - .. raw:: html - - + 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 - - **diff_mode** - - .. raw:: html + .. ansible-attribute:: - + 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: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **platform** - - .. raw:: html - - + fqcn: ns2.col.sub.foo3 + plugin_type: module + name: "platform" .. raw:: html @@ -346,17 +329,17 @@ 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 + .. ansible-return-value:: - **bar** + fqcn: ns2.col.sub.foo3 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..2e3a8e6a 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** + .. ansible-option:: - .. raw:: html - - + fqcn: ns2.flatcol.foo2 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -161,17 +164,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
- .. _ansible_collections.ns2.flatcol.foo2_module__return-bar: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **bar** + fqcn: ns2.flatcol.foo2 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. 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..0389d79c 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: - - .. rst-class:: ansible-option-title - **foo** - - .. raw:: html + .. ansible-option:: - + 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: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **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: - - .. rst-class:: ansible-option-title + .. ansible-option:: - **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,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
- .. _ansible_collections.ns2.flatcol.foo_module__return-bar: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **bar** + fqcn: ns2.flatcol.foo + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. ansible-option-type-line:: diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/bar_filter.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/bar_filter.rst index 7e7ac1e8..f0742753 100644 --- a/tests/functional/baseline-simplified-rst-squash-hierarchy/bar_filter.rst +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/bar_filter.rst @@ -48,9 +48,9 @@ This describes the input of the filter, the value before ``| ns2.col.bar``.
-
-

Input

- +
+ Input +

dictionary / required @@ -86,9 +86,9 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)``

-
-

foo

- +
+ foo +

list / elements=dictionary @@ -102,9 +102,9 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)``

-
-

bar

- +
+ bar +

boolean

@@ -144,9 +144,9 @@ example: ``input | ns2.col.bar(key1=value1, key2=value2, ...)``
-
-

baz

- +
+ baz +

string

@@ -218,8 +218,8 @@ Return Value
-

Return value

- + Return value +

dictionary

diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/bar_test.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/bar_test.rst index 01fd25f1..8ceb146f 100644 --- a/tests/functional/baseline-simplified-rst-squash-hierarchy/bar_test.rst +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/bar_test.rst @@ -48,9 +48,9 @@ This describes the input of the test, the value before ``is ns2.col.bar`` or ``i
-
-

Input

- +
+ Input +

path

@@ -98,8 +98,8 @@ Return Value
-

Return value

- + Return value +

boolean

diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo2_module.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo2_module.rst index 361cf078..50c62b75 100644 --- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo2_module.rst +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo2_module.rst @@ -48,9 +48,9 @@ Parameters
-
-

bar

- +
+ bar +

string

@@ -161,8 +161,8 @@ The following are the fields unique to this module:
-

bar

- + bar +

string

diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_become.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_become.rst index 17def721..3e93b055 100644 --- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_become.rst +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_become.rst @@ -58,9 +58,9 @@ Parameters
-
-

bar

- +
+ bar +

string

@@ -84,9 +84,9 @@ Parameters
-
-

become_exe

- +
+ become_exe +

string

@@ -141,9 +141,9 @@ Parameters
-
-

become_user

- +
+ become_user +

string

diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_cache.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_cache.rst index 8f368d98..13a476df 100644 --- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_cache.rst +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_cache.rst @@ -47,9 +47,9 @@ Parameters
-
-

_uri

- +
+ _uri +

path / required @@ -75,9 +75,9 @@ Parameters

-
-

bar

- +
+ bar +

string

diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_callback.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_callback.rst index ce705a4d..a617246f 100644 --- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_callback.rst +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_callback.rst @@ -52,9 +52,9 @@ Parameters
-
-

bar

- +
+ bar +

string

diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_connection.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_connection.rst index 565feede..e0a7b1c3 100644 --- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_connection.rst +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_connection.rst @@ -47,9 +47,9 @@ Parameters
-
-

bar

- +
+ bar +

integer

@@ -61,9 +61,9 @@ Parameters
-
-

host

- +
+ host +

string

diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_filter.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_filter.rst index f104e0fc..95881e95 100644 --- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_filter.rst +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_filter.rst @@ -48,9 +48,9 @@ This describes the input of the filter, the value before ``| ns2.col.foo``.
-
-

Input

- +
+ Input +

string / required @@ -86,9 +86,9 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``

-
-

bar

- +
+ bar +

string

@@ -100,9 +100,9 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``
-
-

foo

- +
+ foo +

list / elements=dictionary @@ -150,8 +150,8 @@ Return Value

-

Return value

- + Return value +

string

diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_inventory.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_inventory.rst index 81e828fa..e11f6d12 100644 --- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_inventory.rst +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_inventory.rst @@ -47,9 +47,9 @@ Parameters
-
-

bar

- +
+ bar +

string

diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_lookup.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_lookup.rst index 45dc0d82..bd7f536e 100644 --- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_lookup.rst +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_lookup.rst @@ -46,9 +46,9 @@ Terms
-
-

Terms

- +
+ Terms +

list / elements=string @@ -86,9 +86,9 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query('

-
-

bar

- +
+ bar +

string

@@ -141,8 +141,8 @@ Return Value
-

Return value

- + Return value +

list / elements=string diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_module.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_module.rst index 353aad99..555681be 100644 --- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_module.rst +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_module.rst @@ -60,10 +60,10 @@ Parameters

-
-
-

bar

- +
+
+ bar +

aliases: baz

list @@ -78,9 +78,9 @@ Parameters

-
-

foo

- +
+ foo +

string / required @@ -92,9 +92,9 @@ Parameters

-
-

subfoo

- +
+ subfoo +

dictionary

@@ -107,9 +107,9 @@ Parameters
-
-

foo

- +
+ foo +

string / required @@ -244,8 +244,8 @@ The following are the fields unique to this module:

-

bar

- + bar +

string

diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_role.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_role.rst index a509eeb9..e2487a16 100644 --- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_role.rst +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_role.rst @@ -57,9 +57,9 @@ Parameters
-
-

foo_param_1

- +
+ foo_param_1 +

string

@@ -72,9 +72,9 @@ Parameters
-
-

foo_param_2

- +
+ foo_param_2 +

integer

diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_shell.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_shell.rst index 6990cc5b..a5a02c0a 100644 --- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_shell.rst +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_shell.rst @@ -47,9 +47,9 @@ Parameters
-
-

bar

- +
+ bar +

string

@@ -61,9 +61,9 @@ Parameters
-
-

remote_tmp

- +
+ remote_tmp +

string

diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_test.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_test.rst index 3034dc89..0a76183b 100644 --- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_test.rst +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_test.rst @@ -47,9 +47,9 @@ This describes the input of the test, the value before ``is ns2.col.foo`` or ``i
-
-

Input

- +
+ Input +

dictionary / required @@ -85,9 +85,9 @@ examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is

-
-

bar

- +
+ bar +

string

@@ -133,8 +133,8 @@ Return Value
-

Return value

- + Return value +

boolean

diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_vars.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_vars.rst index 8ceb2ed9..71d420e9 100644 --- a/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_vars.rst +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/foo_vars.rst @@ -58,9 +58,9 @@ Parameters
-
-

_valid_extensions

- +
+ _valid_extensions +

list / elements=string @@ -87,9 +87,9 @@ Parameters

-
-

bar

- +
+ bar +

string

diff --git a/tests/functional/baseline-simplified-rst-squash-hierarchy/sub.foo3_module.rst b/tests/functional/baseline-simplified-rst-squash-hierarchy/sub.foo3_module.rst index f925bef4..a07efc02 100644 --- a/tests/functional/baseline-simplified-rst-squash-hierarchy/sub.foo3_module.rst +++ b/tests/functional/baseline-simplified-rst-squash-hierarchy/sub.foo3_module.rst @@ -47,9 +47,9 @@ Parameters
-
-

bar

- +
+ bar +

string

@@ -160,8 +160,8 @@ The following are the fields unique to this module:
-

bar

- + bar +

string

diff --git a/tests/functional/baseline-simplified-rst/collections/ns/col2/foo2_module.rst b/tests/functional/baseline-simplified-rst/collections/ns/col2/foo2_module.rst index 5566b4d9..6d40502e 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns/col2/foo2_module.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns/col2/foo2_module.rst @@ -61,9 +61,9 @@ Parameters
-
-

bar

- +
+ bar +

list / elements=integer @@ -76,9 +76,9 @@ Parameters

-
-

foo

- +
+ foo +

string

@@ -89,9 +89,9 @@ Parameters
-
-

subfoo

- +
+ subfoo +

dictionary

@@ -103,9 +103,9 @@ Parameters
-
-

BaZ

- +
+ BaZ +

integer

@@ -117,9 +117,9 @@ Parameters
-
-

foo

- +
+ foo +

string / required @@ -251,8 +251,8 @@ The following are the fields unique to this module:

-

bar

- + bar +

string

diff --git a/tests/functional/baseline-simplified-rst/collections/ns/col2/foo3_module.rst b/tests/functional/baseline-simplified-rst/collections/ns/col2/foo3_module.rst index 7a3ef248..d15b1494 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns/col2/foo3_module.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns/col2/foo3_module.rst @@ -56,9 +56,9 @@ Parameters
-
-

bar

- +
+ bar +

list / elements=integer @@ -70,9 +70,9 @@ Parameters

-
-

foo

- +
+ foo +

string

@@ -83,9 +83,9 @@ Parameters
-
-

subfoo

- +
+ subfoo +

dictionary

@@ -97,9 +97,9 @@ Parameters
-
-

foo

- +
+ foo +

string / required diff --git a/tests/functional/baseline-simplified-rst/collections/ns/col2/foo4_module.rst b/tests/functional/baseline-simplified-rst/collections/ns/col2/foo4_module.rst index aa3e3456..eedbfbc1 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns/col2/foo4_module.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns/col2/foo4_module.rst @@ -45,9 +45,9 @@ Parameters

-
-

correct_array_stubs

- +
+ correct_array_stubs +

string

@@ -64,9 +64,9 @@ Parameters
-
-

existing

- +
+ existing +

string

@@ -97,9 +97,9 @@ Parameters
-
-

incorrect_array_stubs

- +
+ incorrect_array_stubs +

string

@@ -115,9 +115,9 @@ Parameters
-
-

not_existing

- +
+ not_existing +

string

diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/bar_filter.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/bar_filter.rst index 7e7ac1e8..f0742753 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/col/bar_filter.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/bar_filter.rst @@ -48,9 +48,9 @@ This describes the input of the filter, the value before ``| ns2.col.bar``.
-
-

Input

- +
+ Input +

dictionary / required @@ -86,9 +86,9 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)``

-
-

foo

- +
+ foo +

list / elements=dictionary @@ -102,9 +102,9 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)``

-
-

bar

- +
+ bar +

boolean

@@ -144,9 +144,9 @@ example: ``input | ns2.col.bar(key1=value1, key2=value2, ...)``
-
-

baz

- +
+ baz +

string

@@ -218,8 +218,8 @@ Return Value
-

Return value

- + Return value +

dictionary

diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/bar_test.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/bar_test.rst index 01fd25f1..8ceb146f 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/col/bar_test.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/bar_test.rst @@ -48,9 +48,9 @@ This describes the input of the test, the value before ``is ns2.col.bar`` or ``i
-
-

Input

- +
+ Input +

path

@@ -98,8 +98,8 @@ Return Value
-

Return value

- + Return value +

boolean

diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo2_module.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo2_module.rst index 361cf078..50c62b75 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo2_module.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo2_module.rst @@ -48,9 +48,9 @@ Parameters
-
-

bar

- +
+ bar +

string

@@ -161,8 +161,8 @@ The following are the fields unique to this module:
-

bar

- + bar +

string

diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_become.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_become.rst index 17def721..3e93b055 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_become.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_become.rst @@ -58,9 +58,9 @@ Parameters
-
-

bar

- +
+ bar +

string

@@ -84,9 +84,9 @@ Parameters
-
-

become_exe

- +
+ become_exe +

string

@@ -141,9 +141,9 @@ Parameters
-
-

become_user

- +
+ become_user +

string

diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_cache.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_cache.rst index 8f368d98..13a476df 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_cache.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_cache.rst @@ -47,9 +47,9 @@ Parameters
-
-

_uri

- +
+ _uri +

path / required @@ -75,9 +75,9 @@ Parameters

-
-

bar

- +
+ bar +

string

diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_callback.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_callback.rst index ce705a4d..a617246f 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_callback.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_callback.rst @@ -52,9 +52,9 @@ Parameters
-
-

bar

- +
+ bar +

string

diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_connection.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_connection.rst index 565feede..e0a7b1c3 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_connection.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_connection.rst @@ -47,9 +47,9 @@ Parameters
-
-

bar

- +
+ bar +

integer

@@ -61,9 +61,9 @@ Parameters
-
-

host

- +
+ host +

string

diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_filter.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_filter.rst index f104e0fc..95881e95 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_filter.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_filter.rst @@ -48,9 +48,9 @@ This describes the input of the filter, the value before ``| ns2.col.foo``.
-
-

Input

- +
+ Input +

string / required @@ -86,9 +86,9 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``

-
-

bar

- +
+ bar +

string

@@ -100,9 +100,9 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``
-
-

foo

- +
+ foo +

list / elements=dictionary @@ -150,8 +150,8 @@ Return Value

-

Return value

- + Return value +

string

diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_inventory.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_inventory.rst index 81e828fa..e11f6d12 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_inventory.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_inventory.rst @@ -47,9 +47,9 @@ Parameters
-
-

bar

- +
+ bar +

string

diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_lookup.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_lookup.rst index 45dc0d82..bd7f536e 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_lookup.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_lookup.rst @@ -46,9 +46,9 @@ Terms
-
-

Terms

- +
+ Terms +

list / elements=string @@ -86,9 +86,9 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query('

-
-

bar

- +
+ bar +

string

@@ -141,8 +141,8 @@ Return Value
-

Return value

- + Return value +

list / elements=string diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_module.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_module.rst index 353aad99..555681be 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_module.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_module.rst @@ -60,10 +60,10 @@ Parameters

-
-
-

bar

- +
+
+ bar +

aliases: baz

list @@ -78,9 +78,9 @@ Parameters

-
-

foo

- +
+ foo +

string / required @@ -92,9 +92,9 @@ Parameters

-
-

subfoo

- +
+ subfoo +

dictionary

@@ -107,9 +107,9 @@ Parameters
-
-

foo

- +
+ foo +

string / required @@ -244,8 +244,8 @@ The following are the fields unique to this module:

-

bar

- + bar +

string

diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_role.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_role.rst index a509eeb9..e2487a16 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_role.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_role.rst @@ -57,9 +57,9 @@ Parameters
-
-

foo_param_1

- +
+ foo_param_1 +

string

@@ -72,9 +72,9 @@ Parameters
-
-

foo_param_2

- +
+ foo_param_2 +

integer

diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_shell.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_shell.rst index 6990cc5b..a5a02c0a 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_shell.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_shell.rst @@ -47,9 +47,9 @@ Parameters
-
-

bar

- +
+ bar +

string

@@ -61,9 +61,9 @@ Parameters
-
-

remote_tmp

- +
+ remote_tmp +

string

diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_test.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_test.rst index 3034dc89..0a76183b 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_test.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_test.rst @@ -47,9 +47,9 @@ This describes the input of the test, the value before ``is ns2.col.foo`` or ``i
-
-

Input

- +
+ Input +

dictionary / required @@ -85,9 +85,9 @@ examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is

-
-

bar

- +
+ bar +

string

@@ -133,8 +133,8 @@ Return Value
-

Return value

- + Return value +

boolean

diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_vars.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_vars.rst index 8ceb2ed9..71d420e9 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_vars.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/foo_vars.rst @@ -58,9 +58,9 @@ Parameters
-
-

_valid_extensions

- +
+ _valid_extensions +

list / elements=string @@ -87,9 +87,9 @@ Parameters

-
-

bar

- +
+ bar +

string

diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/col/sub.foo3_module.rst b/tests/functional/baseline-simplified-rst/collections/ns2/col/sub.foo3_module.rst index f925bef4..a07efc02 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/col/sub.foo3_module.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/col/sub.foo3_module.rst @@ -47,9 +47,9 @@ Parameters
-
-

bar

- +
+ bar +

string

@@ -160,8 +160,8 @@ The following are the fields unique to this module:
-

bar

- + bar +

string

diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/flatcol/foo2_module.rst b/tests/functional/baseline-simplified-rst/collections/ns2/flatcol/foo2_module.rst index 4b1cdcaf..3fa06a02 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/flatcol/foo2_module.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/flatcol/foo2_module.rst @@ -47,9 +47,9 @@ Parameters
-
-

bar

- +
+ bar +

string

@@ -98,8 +98,8 @@ The following are the fields unique to this module:
-

bar

- + bar +

string

diff --git a/tests/functional/baseline-simplified-rst/collections/ns2/flatcol/foo_module.rst b/tests/functional/baseline-simplified-rst/collections/ns2/flatcol/foo_module.rst index 5280dbdf..40fd9de3 100644 --- a/tests/functional/baseline-simplified-rst/collections/ns2/flatcol/foo_module.rst +++ b/tests/functional/baseline-simplified-rst/collections/ns2/flatcol/foo_module.rst @@ -48,10 +48,10 @@ Parameters
-
-
-

bar

- +
+
+ bar +

aliases: baz

list @@ -66,9 +66,9 @@ Parameters

-
-

foo

- +
+ foo +

string / required @@ -80,10 +80,10 @@ Parameters

-
-
-

subfoo

- +
+
+ subfoo +

aliases: subbaz

dictionary @@ -97,12 +97,12 @@ Parameters

-
-
-
-
-

foo

- +
+
+
+
+ foo +

aliases: bam

string @@ -163,8 +163,8 @@ The following are the fields unique to this module:

-

bar

- + bar +

string

diff --git a/tests/functional/baseline-squash-hierarchy/bar_filter.rst b/tests/functional/baseline-squash-hierarchy/bar_filter.rst index 02bd2e03..812a6fb5 100644 --- a/tests/functional/baseline-squash-hierarchy/bar_filter.rst +++ b/tests/functional/baseline-squash-hierarchy/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,14 @@ 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"] .. ansible-option-type-line:: @@ -143,17 +146,14 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)`` * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.bar_filter__parameter-foo: - - .. rst-class:: ansible-option-title - **foo** - - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.bar + plugin_type: filter + name: "foo" + full_keys: + - ["foo"] .. ansible-option-type-line:: @@ -180,17 +180,14 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)`` * - .. raw:: html
-
- .. _ansible_collections.ns2.col.bar_filter__parameter-bar: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html - - + fqcn: ns2.col.bar + plugin_type: filter + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -246,17 +243,14 @@ example: ``input | ns2.col.bar(key1=value1, key2=value2, ...)`` * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.bar_filter__parameter-baz: - .. rst-class:: ansible-option-title + .. ansible-option:: - **baz** - - .. raw:: html - - + fqcn: ns2.col.bar + plugin_type: filter + name: "baz" + full_keys: + - ["baz"] .. ansible-option-type-line:: @@ -351,17 +345,17 @@ Return Value * - .. raw:: html
-
- .. _ansible_collections.ns2.col.bar_filter__return-_value: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **Return value** + fqcn: ns2.col.bar + plugin_type: filter + name: "Return value" + full_keys: + - ["_value"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. ansible-option-type-line:: diff --git a/tests/functional/baseline-squash-hierarchy/bar_test.rst b/tests/functional/baseline-squash-hierarchy/bar_test.rst index 7f09cc31..f4543b19 100644 --- a/tests/functional/baseline-squash-hierarchy/bar_test.rst +++ b/tests/functional/baseline-squash-hierarchy/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,14 @@ 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** + .. ansible-option:: - .. raw:: html - - + fqcn: ns2.col.bar + plugin_type: test + name: "Input" + full_keys: + - ["_input"] .. ansible-option-type-line:: @@ -165,17 +168,17 @@ Return Value * - .. raw:: html
-
- .. _ansible_collections.ns2.col.bar_test__return-_value: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **Return value** + fqcn: ns2.col.bar + plugin_type: test + name: "Return value" + full_keys: + - ["_value"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. ansible-option-type-line:: diff --git a/tests/functional/baseline-squash-hierarchy/foo2_module.rst b/tests/functional/baseline-squash-hierarchy/foo2_module.rst index 62ba96ab..95c8a112 100644 --- a/tests/functional/baseline-squash-hierarchy/foo2_module.rst +++ b/tests/functional/baseline-squash-hierarchy/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: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html + .. ansible-option:: - + 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: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **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** + .. ansible-attribute:: - .. raw:: html - - + 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 - - **diff_mode** - - .. raw:: html + .. ansible-attribute:: - + 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: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **platform** - - .. raw:: html - - + fqcn: ns2.col.foo2 + plugin_type: module + name: "platform" .. raw:: html @@ -347,17 +330,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo2_module__return-bar: - .. rst-class:: ansible-option-title + .. ansible-return-value:: - **bar** + fqcn: ns2.col.foo2 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. ansible-option-type-line:: diff --git a/tests/functional/baseline-squash-hierarchy/foo_become.rst b/tests/functional/baseline-squash-hierarchy/foo_become.rst index a2e2948f..ffe66ca2 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_become.rst +++ b/tests/functional/baseline-squash-hierarchy/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-squash-hierarchy/foo_cache.rst b/tests/functional/baseline-squash-hierarchy/foo_cache.rst index 539a4ae9..84e75e86 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_cache.rst +++ b/tests/functional/baseline-squash-hierarchy/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-squash-hierarchy/foo_callback.rst b/tests/functional/baseline-squash-hierarchy/foo_callback.rst index 9a277b2c..18e43008 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_callback.rst +++ b/tests/functional/baseline-squash-hierarchy/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-squash-hierarchy/foo_cliconf.rst b/tests/functional/baseline-squash-hierarchy/foo_cliconf.rst index b570e0a4..78a95549 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_cliconf.rst +++ b/tests/functional/baseline-squash-hierarchy/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-squash-hierarchy/foo_connection.rst b/tests/functional/baseline-squash-hierarchy/foo_connection.rst index 84d69342..821a5ef5 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_connection.rst +++ b/tests/functional/baseline-squash-hierarchy/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-squash-hierarchy/foo_filter.rst b/tests/functional/baseline-squash-hierarchy/foo_filter.rst index aafe1534..bd580cf7 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_filter.rst +++ b/tests/functional/baseline-squash-hierarchy/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,14 @@ 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 - **Input** + .. ansible-option:: - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: filter + name: "Input" + full_keys: + - ["_input"] .. ansible-option-type-line:: @@ -143,17 +146,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** + .. ansible-option:: - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: filter + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -180,17 +180,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** + .. ansible-option:: - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: filter + name: "foo" + full_keys: + - ["foo"] .. ansible-option-type-line:: @@ -259,17 +256,17 @@ Return Value * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_filter__return-_value: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **Return value** + fqcn: ns2.col.foo + plugin_type: filter + name: "Return value" + full_keys: + - ["_value"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. ansible-option-type-line:: diff --git a/tests/functional/baseline-squash-hierarchy/foo_inventory.rst b/tests/functional/baseline-squash-hierarchy/foo_inventory.rst index abce5ac6..f7256178 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_inventory.rst +++ b/tests/functional/baseline-squash-hierarchy/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-squash-hierarchy/foo_lookup.rst b/tests/functional/baseline-squash-hierarchy/foo_lookup.rst index f4e53de0..3ab43d85 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_lookup.rst +++ b/tests/functional/baseline-squash-hierarchy/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,14 @@ Terms * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_lookup__parameter-_terms: - .. rst-class:: ansible-option-title - - **Terms** - - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: lookup + name: "Terms" + full_keys: + - ["_terms"] .. ansible-option-type-line:: @@ -142,17 +145,14 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query(' * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_lookup__parameter-bar: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: lookup + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -229,17 +229,17 @@ Return Value * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_lookup__return-_raw: - .. rst-class:: ansible-option-title + .. ansible-return-value:: - **Return value** + fqcn: ns2.col.foo + plugin_type: lookup + name: "Return value" + full_keys: + - ["_raw"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. ansible-option-type-line:: diff --git a/tests/functional/baseline-squash-hierarchy/foo_module.rst b/tests/functional/baseline-squash-hierarchy/foo_module.rst index 1f14bfe6..258609ee 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_module.rst +++ b/tests/functional/baseline-squash-hierarchy/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:: @@ -96,19 +102,15 @@ Parameters * - .. raw:: html
-
-
- - .. _ansible_collections.ns2.col.foo_module__parameter-bar: - .. _ansible_collections.ns2.col.foo_module__parameter-baz: - .. rst-class:: ansible-option-title + .. ansible-option:: - **bar** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: module + name: "bar" + full_keys: + - ["bar"] + - ["baz"] .. ansible-option-type-line:: @@ -138,17 +140,14 @@ Parameters * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_module__parameter-foo: - - .. rst-class:: ansible-option-title - - **foo** - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: module + name: "foo" + full_keys: + - ["foo"] .. ansible-option-type-line:: @@ -172,17 +171,14 @@ Parameters * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_module__parameter-subfoo: - - .. rst-class:: ansible-option-title - **subfoo** - - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: module + name: "subfoo" + full_keys: + - ["subfoo"] .. ansible-option-type-line:: @@ -209,21 +205,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 +268,12 @@ Attributes * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_module__attribute-action_group: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **action_group** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: module + name: "action_group" .. raw:: html @@ -317,17 +305,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 +342,12 @@ Attributes * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_module__attribute-diff_mode: - .. rst-class:: ansible-option-title + .. ansible-attribute:: - **diff_mode** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: module + name: "diff_mode" .. raw:: html @@ -401,17 +379,12 @@ Attributes * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_module__attribute-platform: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **platform** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: module + name: "platform" .. raw:: html @@ -504,17 +477,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_module__return-bar: + .. ansible-return-value:: - .. rst-class:: ansible-option-title - - **bar** + fqcn: ns2.col.foo + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. ansible-option-type-line:: diff --git a/tests/functional/baseline-squash-hierarchy/foo_redirect_module.rst b/tests/functional/baseline-squash-hierarchy/foo_redirect_module.rst index 2b01a6c0..10b231f5 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_redirect_module.rst +++ b/tests/functional/baseline-squash-hierarchy/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-squash-hierarchy/foo_role.rst b/tests/functional/baseline-squash-hierarchy/foo_role.rst index dd66290c..205b6000 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_role.rst +++ b/tests/functional/baseline-squash-hierarchy/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-squash-hierarchy/foo_shell.rst b/tests/functional/baseline-squash-hierarchy/foo_shell.rst index b021c328..5e0dccf9 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_shell.rst +++ b/tests/functional/baseline-squash-hierarchy/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-squash-hierarchy/foo_strategy.rst b/tests/functional/baseline-squash-hierarchy/foo_strategy.rst index 8d8b164e..71f93dda 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_strategy.rst +++ b/tests/functional/baseline-squash-hierarchy/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-squash-hierarchy/foo_test.rst b/tests/functional/baseline-squash-hierarchy/foo_test.rst index b369f125..de21ce8f 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_test.rst +++ b/tests/functional/baseline-squash-hierarchy/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,14 @@ 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: - .. rst-class:: ansible-option-title - - **Input** - - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: test + name: "Input" + full_keys: + - ["_input"] .. ansible-option-type-line:: @@ -140,17 +143,14 @@ examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo_test__parameter-bar: + .. ansible-option:: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: test + name: "bar" + full_keys: + - ["bar"] .. ansible-option-type-line:: @@ -219,17 +219,17 @@ Return Value * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_test__return-_value: - .. rst-class:: ansible-option-title + .. ansible-return-value:: - **Return value** + fqcn: ns2.col.foo + plugin_type: test + name: "Return value" + full_keys: + - ["_value"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. ansible-option-type-line:: diff --git a/tests/functional/baseline-squash-hierarchy/foo_vars.rst b/tests/functional/baseline-squash-hierarchy/foo_vars.rst index f460e625..9bc202ad 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_vars.rst +++ b/tests/functional/baseline-squash-hierarchy/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:: @@ -94,17 +100,14 @@ Parameters * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_vars__parameter-_valid_extensions: - - .. rst-class:: ansible-option-title - - **_valid_extensions** - .. raw:: html + .. ansible-option:: - + fqcn: ns2.col.foo + plugin_type: vars + name: "_valid_extensions" + full_keys: + - ["_valid_extensions"] .. ansible-option-type-line:: @@ -150,17 +153,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-squash-hierarchy/is_bar_test.rst b/tests/functional/baseline-squash-hierarchy/is_bar_test.rst index 86dbccab..21ce1a6c 100644 --- a/tests/functional/baseline-squash-hierarchy/is_bar_test.rst +++ b/tests/functional/baseline-squash-hierarchy/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-squash-hierarchy/sub.foo3_module.rst b/tests/functional/baseline-squash-hierarchy/sub.foo3_module.rst index b55705df..b48ab50f 100644 --- a/tests/functional/baseline-squash-hierarchy/sub.foo3_module.rst +++ b/tests/functional/baseline-squash-hierarchy/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: - .. rst-class:: ansible-option-title - - **bar** - - .. raw:: html + .. ansible-option:: - + 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: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **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** + .. ansible-attribute:: - .. raw:: html - - + 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 - - **diff_mode** - - .. raw:: html + .. ansible-attribute:: - + 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: + .. ansible-attribute:: - .. rst-class:: ansible-option-title - - **platform** - - .. raw:: html - - + fqcn: ns2.col.sub.foo3 + plugin_type: module + name: "platform" .. raw:: html @@ -346,17 +329,17 @@ 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 + .. ansible-return-value:: - **bar** + fqcn: ns2.col.sub.foo3 + plugin_type: module + name: "bar" + full_keys: + - ["bar"] .. raw:: html - - + :url: data:text/plain;base64,IA== .. ansible-option-type-line:: diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/bar_filter.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/bar_filter.rst index bd3d135a..682edcac 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/bar_filter.rst +++ b/tests/functional/baseline-use-html-blobs/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:: @@ -82,9 +88,9 @@ This describes the input of the filter, the value before ``| ns2.col.bar``.
-
-

Input

- +
+ Input +

dictionary / required @@ -122,9 +128,9 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)``

-
-

foo

- +
+ foo +

list / elements=dictionary @@ -138,9 +144,9 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)``

-
-

bar

- +
+ bar +

boolean

@@ -182,9 +188,9 @@ example: ``input | ns2.col.bar(key1=value1, key2=value2, ...)``
-
-

baz

- +
+ baz +

string

@@ -269,7 +275,7 @@ Return Value
-

Return value

+ Return value

dictionary diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/bar_test.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/bar_test.rst index 362a8e7f..ac0a0344 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/bar_test.rst +++ b/tests/functional/baseline-use-html-blobs/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:: @@ -80,9 +86,9 @@ This describes the input of the test, the value before ``is ns2.col.bar`` or ``i

-
-

Input

- +
+ Input +

path

@@ -144,7 +150,7 @@ Return Value
-

Return value

+ Return value

boolean diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo2_module.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo2_module.rst index 172ef06f..d02f437e 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo2_module.rst +++ b/tests/functional/baseline-use-html-blobs/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:: @@ -80,9 +86,9 @@ Parameters

-
-

bar

- +
+ bar +

string

@@ -118,17 +124,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 @@ -160,17 +161,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 @@ -202,17 +198,12 @@ Attributes * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo2_module__attribute-diff_mode: - - .. rst-class:: ansible-option-title - **diff_mode** - - .. raw:: html + .. ansible-attribute:: - + fqcn: ns2.col.foo2 + plugin_type: module + name: "diff_mode" .. raw:: html @@ -244,17 +235,12 @@ Attributes * - .. raw:: html
-
- .. _ansible_collections.ns2.col.foo2_module__attribute-platform: - - .. rst-class:: ansible-option-title - - **platform** - - .. raw:: html + .. ansible-attribute:: - + fqcn: ns2.col.foo2 + plugin_type: module + name: "platform" .. raw:: html @@ -327,7 +313,7 @@ Common return values are documented :ref:`here `, the foll
-

bar

+ bar

string diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_become.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_become.rst index f62fb1a9..75f1607b 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_become.rst +++ b/tests/functional/baseline-use-html-blobs/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:: @@ -90,9 +96,9 @@ Parameters

-
-

bar

- +
+ bar +

string

@@ -116,9 +122,9 @@ Parameters
-
-

become_exe

- +
+ become_exe +

string

@@ -173,9 +179,9 @@ Parameters
-
-

become_user

- +
+ become_user +

string

diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_cache.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_cache.rst index 27ce2092..e37a941d 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_cache.rst +++ b/tests/functional/baseline-use-html-blobs/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:: @@ -81,9 +87,9 @@ Parameters
-
-

_uri

- +
+ _uri +

path / required @@ -109,9 +115,9 @@ Parameters

-
-

bar

- +
+ bar +

string

diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_callback.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_callback.rst index 61c9ff27..b70a9441 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_callback.rst +++ b/tests/functional/baseline-use-html-blobs/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:: @@ -87,9 +93,9 @@ Parameters
-
-

bar

- +
+ bar +

string

diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_cliconf.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_cliconf.rst index b570e0a4..78a95549 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_cliconf.rst +++ b/tests/functional/baseline-use-html-blobs/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-use-html-blobs/collections/ns2/col/foo_connection.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_connection.rst index cd38a355..9f96ab9c 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_connection.rst +++ b/tests/functional/baseline-use-html-blobs/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:: @@ -81,9 +87,9 @@ Parameters
-
-

bar

- +
+ bar +

integer

@@ -95,9 +101,9 @@ Parameters
-
-

host

- +
+ host +

string

diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_filter.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_filter.rst index 70dd3648..c50e6b41 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_filter.rst +++ b/tests/functional/baseline-use-html-blobs/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:: @@ -82,9 +88,9 @@ This describes the input of the filter, the value before ``| ns2.col.foo``.
-
-

Input

- +
+ Input +

string / required @@ -122,9 +128,9 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``

-
-

bar

- +
+ bar +

string

@@ -136,9 +142,9 @@ example: ``input | ns2.col.foo(key1=value1, key2=value2, ...)``
-
-

foo

- +
+ foo +

list / elements=dictionary @@ -198,7 +204,7 @@ Return Value

-

Return value

+ Return value

string diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_inventory.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_inventory.rst index da39b82a..f88a43c6 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_inventory.rst +++ b/tests/functional/baseline-use-html-blobs/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:: @@ -81,9 +87,9 @@ Parameters

-
-

bar

- +
+ bar +

string

diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_lookup.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_lookup.rst index ed6f0b69..4e9647e1 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_lookup.rst +++ b/tests/functional/baseline-use-html-blobs/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:: @@ -80,9 +86,9 @@ Terms
-
-

Terms

- +
+ Terms +

list / elements=string @@ -122,9 +128,9 @@ examples: ``lookup('ns2.col.foo', key1=value1, key2=value2, ...)`` and ``query('

-
-

bar

- +
+ bar +

string

@@ -190,7 +196,7 @@ Return Value
-

Return value

+ Return value

list diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_module.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_module.rst index 61031b8a..7bf3b0d2 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_module.rst +++ b/tests/functional/baseline-use-html-blobs/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:: @@ -94,10 +100,10 @@ Parameters

-
-
-

bar

- +
+
+ bar +

aliases: baz

list @@ -112,9 +118,9 @@ Parameters

-
-

foo

- +
+ foo +

string / required @@ -126,9 +132,9 @@ Parameters

-
-

subfoo

- +
+ subfoo +

dictionary

@@ -140,9 +146,9 @@ Parameters
-
-

foo

- +
+ foo +

string / required @@ -181,17 +187,12 @@ Attributes * - .. raw:: html

-
- - .. _ansible_collections.ns2.col.foo_module__attribute-action_group: - .. rst-class:: ansible-option-title + .. ansible-attribute:: - **action_group** - - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: module + name: "action_group" .. raw:: html @@ -223,17 +224,12 @@ Attributes * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_module__attribute-check_mode: - - .. rst-class:: ansible-option-title - - **check_mode** - .. raw:: html + .. ansible-attribute:: - + fqcn: ns2.col.foo + plugin_type: module + name: "check_mode" .. raw:: html @@ -265,17 +261,12 @@ Attributes * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_module__attribute-diff_mode: - - .. rst-class:: ansible-option-title - **diff_mode** - - .. raw:: html + .. ansible-attribute:: - + fqcn: ns2.col.foo + plugin_type: module + name: "diff_mode" .. raw:: html @@ -307,17 +298,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 @@ -409,7 +395,7 @@ Common return values are documented :ref:`here `, the foll
-

bar

+ bar

string diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_redirect_module.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_redirect_module.rst index 2b01a6c0..10b231f5 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_redirect_module.rst +++ b/tests/functional/baseline-use-html-blobs/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-use-html-blobs/collections/ns2/col/foo_role.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_role.rst index 6ce3601c..22780be6 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_role.rst +++ b/tests/functional/baseline-use-html-blobs/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 @@ -89,9 +101,9 @@ Parameters

-
-

foo_param_1

- +
+ foo_param_1 +

string

@@ -104,9 +116,9 @@ Parameters
-
-

foo_param_2

- +
+ foo_param_2 +

integer

@@ -143,17 +155,13 @@ Attributes * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.foo_role__attribute-main__check_mode: - - .. rst-class:: ansible-option-title - **check_mode** + .. ansible-attribute:: - .. raw:: html - - + fqcn: ns2.col.foo + plugin_type: role + role_entrypoint: "main" + name: "check_mode" .. raw:: html @@ -185,17 +193,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-use-html-blobs/collections/ns2/col/foo_shell.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_shell.rst index 55cb6b15..c03fb9eb 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_shell.rst +++ b/tests/functional/baseline-use-html-blobs/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:: @@ -81,9 +87,9 @@ Parameters
-
-

bar

- +
+ bar +

string

@@ -95,9 +101,9 @@ Parameters
-
-

remote_tmp

- +
+ remote_tmp +

string

diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_strategy.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_strategy.rst index 8d8b164e..71f93dda 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_strategy.rst +++ b/tests/functional/baseline-use-html-blobs/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-use-html-blobs/collections/ns2/col/foo_test.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_test.rst index cac164f6..0df2265c 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_test.rst +++ b/tests/functional/baseline-use-html-blobs/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:: @@ -79,9 +85,9 @@ This describes the input of the test, the value before ``is ns2.col.foo`` or ``i
-
-

Input

- +
+ Input +

dictionary / required @@ -119,9 +125,9 @@ examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is

-
-

bar

- +
+ bar +

string

@@ -179,7 +185,7 @@ Return Value
-

Return value

+ Return value

boolean diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_vars.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_vars.rst index 7aa5f100..8b035bba 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_vars.rst +++ b/tests/functional/baseline-use-html-blobs/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:: @@ -92,9 +98,9 @@ Parameters

-
-

_valid_extensions

- +
+ _valid_extensions +

list / elements=string @@ -121,9 +127,9 @@ Parameters

-
-

bar

- +
+ bar +

string

diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/is_bar_test.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/is_bar_test.rst index 86dbccab..21ce1a6c 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/is_bar_test.rst +++ b/tests/functional/baseline-use-html-blobs/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-use-html-blobs/collections/ns2/col/sub.foo3_module.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/sub.foo3_module.rst index d8462e28..4e4804f3 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/sub.foo3_module.rst +++ b/tests/functional/baseline-use-html-blobs/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:: @@ -79,9 +85,9 @@ Parameters
-
-

bar

- +
+ bar +

string

@@ -117,17 +123,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 @@ -159,17 +160,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 @@ -201,17 +197,12 @@ Attributes * - .. raw:: html
-
- - .. _ansible_collections.ns2.col.sub.foo3_module__attribute-diff_mode: - - .. rst-class:: ansible-option-title - **diff_mode** - - .. raw:: html + .. ansible-attribute:: - + fqcn: ns2.col.sub.foo3 + plugin_type: module + name: "diff_mode" .. raw:: html @@ -243,17 +234,12 @@ Attributes * - .. raw:: html
-
- .. _ansible_collections.ns2.col.sub.foo3_module__attribute-platform: - - .. rst-class:: ansible-option-title - - **platform** - - .. raw:: html + .. ansible-attribute:: - + fqcn: ns2.col.sub.foo3 + plugin_type: module + name: "platform" .. raw:: html @@ -326,7 +312,7 @@ Common return values are documented :ref:`here `, the foll
-

bar

+ bar

string diff --git a/tests/functional/build-docs-baseline.sh b/tests/functional/build-docs-baseline.sh index 4936bd50..e539edc1 100755 --- a/tests/functional/build-docs-baseline.sh +++ b/tests/functional/build-docs-baseline.sh @@ -19,7 +19,7 @@ make_docsite_baseline() { set -e ) - rstcheck --report-level warning --ignore-directives ansible-links,ansible-option-type-line --ignore-roles ansopt,ansval,ansretval,ansplugin,ansenvvar,ansenvvarref,ansible-attribute-support-label,ansible-attribute-support-property,ansible-attribute-support-full,ansible-attribute-support-partial,ansible-attribute-support-none,ansible-attribute-support-na,ansible-option-aliases,ansible-option-choices,ansible-option-choices-default-mark,ansible-option-choices-entry,ansible-option-choices-entry-default,ansible-option-configuration,ansible-option-default,ansible-option-default-bold,ansible-option-elements,ansible-option-required,ansible-option-returned-bold,ansible-option-sample-bold,ansible-option-type,ansible-option-versionadded,ansible-rv-sample-value -r "${DEST}" 2>&1 | ( + rstcheck --report-level warning --ignore-directives ansible-links,ansible-option-type-line,ansible-plugin,ansible-role-entrypoint,ansible-attribute,ansible-option,ansible-return-value --ignore-roles ansopt,ansval,ansretval,ansplugin,ansenvvar,ansenvvarref,ansible-attribute-support-label,ansible-attribute-support-property,ansible-attribute-support-full,ansible-attribute-support-partial,ansible-attribute-support-none,ansible-attribute-support-na,ansible-option-aliases,ansible-option-choices,ansible-option-choices-default-mark,ansible-option-choices-entry,ansible-option-choices-entry-default,ansible-option-configuration,ansible-option-default,ansible-option-default-bold,ansible-option-elements,ansible-option-required,ansible-option-returned-bold,ansible-option-sample-bold,ansible-option-type,ansible-option-versionadded,ansible-rv-sample-value -r "${DEST}" 2>&1 | ( set +e grep -v "CRITICAL:rstcheck_core.checker:An \`AttributeError\` error occured." set -e From 651c2029abfa5ff1217d0251fc57bdb0fd72b564 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Tue, 19 Sep 2023 21:52:48 +0200 Subject: [PATCH 2/3] Insert anchor to requirements section programmatically. --- .../docsite/ansible-docsite/plugin.rst.j2 | 8 ++- .../data/docsite/ansible-docsite/role.rst.j2 | 7 +++ src/sphinx_antsibull_ext/directives.py | 50 +++++++++++++++++-- .../schemas/ansible_plugin.py | 6 +++ .../collections/ns/col2/foo2_module.rst | 8 ++- .../collections/ns/col2/foo3_module.rst | 8 ++- .../collections/ns2/col/foo_module.rst | 8 ++- .../collections/ns2/col/foo_vars.rst | 8 ++- .../collections/ns/col2/foo2_module.rst | 8 ++- .../collections/ns/col2/foo3_module.rst | 8 ++- .../collections/ns2/col/foo_module.rst | 8 ++- .../collections/ns2/col/foo_vars.rst | 8 ++- .../collections/ns2/col/foo_module.rst | 8 ++- .../collections/ns2/col/foo_vars.rst | 8 ++- .../baseline-squash-hierarchy/foo_module.rst | 8 ++- .../baseline-squash-hierarchy/foo_vars.rst | 8 ++- .../collections/ns2/col/foo_module.rst | 8 ++- .../collections/ns2/col/foo_vars.rst | 8 ++- tests/functional/build-docs-baseline.sh | 2 +- 19 files changed, 151 insertions(+), 34 deletions(-) diff --git a/src/antsibull_docs/data/docsite/ansible-docsite/plugin.rst.j2 b/src/antsibull_docs/data/docsite/ansible-docsite/plugin.rst.j2 index 78565420..16359c10 100644 --- a/src/antsibull_docs/data/docsite/ansible-docsite/plugin.rst.j2 +++ b/src/antsibull_docs/data/docsite/ansible-docsite/plugin.rst.j2 @@ -158,10 +158,14 @@ Aliases: @{ ', '.join(doc['aliases'] | sort) }@ .. Requirements {% if doc['requirements'] -%} -.. _@{ rst_requirements_ref(plugin_name, plugin_type) }@: - Requirements ------------ + +.. ansible-requirements-anchor:: + + fqcn: @{ plugin_name }@ + plugin_type: @{ plugin_type }@ + {% if plugin_type in ('module', 'module_util') %} The below requirements are needed on the host that executes this @{ plugin_type }@. {% else %} diff --git a/src/antsibull_docs/data/docsite/ansible-docsite/role.rst.j2 b/src/antsibull_docs/data/docsite/ansible-docsite/role.rst.j2 index 59b96e37..e2360fde 100644 --- a/src/antsibull_docs/data/docsite/ansible-docsite/role.rst.j2 +++ b/src/antsibull_docs/data/docsite/ansible-docsite/role.rst.j2 @@ -130,6 +130,13 @@ Synopsis {% if ep_doc['requirements'] -%} Requirements ^^^^^^^^^^^^ + +.. ansible-requirements-anchor:: + + fqcn: @{ plugin_name }@ + plugin_type: role + entrypoint: @{ entry_point }@ + The below requirements are needed on the remote host and/or the local controller node. {% for req in ep_doc['requirements'] %} diff --git a/src/sphinx_antsibull_ext/directives.py b/src/sphinx_antsibull_ext/directives.py index c400a64c..0085943e 100644 --- a/src/sphinx_antsibull_ext/directives.py +++ b/src/sphinx_antsibull_ext/directives.py @@ -32,6 +32,7 @@ AnsibleAttribute, AnsibleOption, AnsiblePlugin, + AnsibleRequirementsAnchor, AnsibleReturnValue, AnsibleRoleEntrypoint, ) @@ -219,6 +220,48 @@ def _run( 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" + ) + ref_title = ( + f"Requirements of the {_plugin_name(content.fqcn, content.plugin_type)}" + ) + 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="") @@ -241,7 +284,7 @@ def _run(self, content_str: str, content: AnsibleAttribute) -> list[nodes.Node]: rst_id, self.env.docname, html_id, - f"{content.name} attribute of {content.fqcn} {content.plugin_type}", + f"{content.name} attribute of {_plugin_name(content.fqcn, content.plugin_type)}", ) permalink = nodes.raw( "", @@ -306,7 +349,7 @@ def _run(self, content_str: str, content: AnsibleOption) -> list[nodes.Node]: rst_id, self.env.docname, html_id, - f"{key} option of {content.fqcn} {content.plugin_type}", + f"{key} option of {_plugin_name(content.fqcn, content.plugin_type)}", ) permalink = nodes.raw( "", @@ -341,7 +384,7 @@ def _run(self, content_str: str, content: AnsibleReturnValue) -> list[nodes.Node rst_id, self.env.docname, html_id, - f"{key} return value of {content.fqcn} {content.plugin_type}", + f"{key} return value of {_plugin_name(content.fqcn, content.plugin_type)}", ) permalink = nodes.raw( "", @@ -357,6 +400,7 @@ def _run(self, content_str: str, content: AnsibleReturnValue) -> list[nodes.Node "ansible-links": _Links, "ansible-plugin": _Plugin, "ansible-role-entrypoint": _RoleEntrypoint, + "ansible-requirements-anchor": _RequirementsAnchor, "ansible-attribute": _Attribute, "ansible-option": _Option, "ansible-return-value": _ReturnValue, diff --git a/src/sphinx_antsibull_ext/schemas/ansible_plugin.py b/src/sphinx_antsibull_ext/schemas/ansible_plugin.py index 59440467..b941dd57 100644 --- a/src/sphinx_antsibull_ext/schemas/ansible_plugin.py +++ b/src/sphinx_antsibull_ext/schemas/ansible_plugin.py @@ -28,6 +28,12 @@ class AnsibleRoleEntrypoint(p.BaseModel): 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 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 1513c455..a2fa8751 100644 --- a/tests/functional/baseline-default/collections/ns/col2/foo2_module.rst +++ b/tests/functional/baseline-default/collections/ns/col2/foo2_module.rst @@ -68,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. 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 4b5f692c..a6c28a01 100644 --- a/tests/functional/baseline-default/collections/ns/col2/foo3_module.rst +++ b/tests/functional/baseline-default/collections/ns/col2/foo3_module.rst @@ -63,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. 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 258609ee..97d5ee02 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_module.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_module.rst @@ -70,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. 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 9bc202ad..943dfc7b 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_vars.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_vars.rst @@ -68,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. 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 1513c455..a2fa8751 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 @@ -68,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. 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 4b5f692c..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 @@ -63,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. 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 258609ee..97d5ee02 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 @@ -70,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. 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 9bc202ad..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 @@ -68,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. 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 258609ee..97d5ee02 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 @@ -70,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. 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 9bc202ad..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 @@ -68,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. diff --git a/tests/functional/baseline-squash-hierarchy/foo_module.rst b/tests/functional/baseline-squash-hierarchy/foo_module.rst index 258609ee..97d5ee02 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_module.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_module.rst @@ -70,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. diff --git a/tests/functional/baseline-squash-hierarchy/foo_vars.rst b/tests/functional/baseline-squash-hierarchy/foo_vars.rst index 9bc202ad..943dfc7b 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_vars.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_vars.rst @@ -68,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. diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_module.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_module.rst index 7bf3b0d2..0c02ae9b 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_module.rst +++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_module.rst @@ -70,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. diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_vars.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_vars.rst index 8b035bba..c211d682 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_vars.rst +++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/foo_vars.rst @@ -68,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. diff --git a/tests/functional/build-docs-baseline.sh b/tests/functional/build-docs-baseline.sh index e539edc1..41cbf51d 100755 --- a/tests/functional/build-docs-baseline.sh +++ b/tests/functional/build-docs-baseline.sh @@ -19,7 +19,7 @@ make_docsite_baseline() { set -e ) - rstcheck --report-level warning --ignore-directives ansible-links,ansible-option-type-line,ansible-plugin,ansible-role-entrypoint,ansible-attribute,ansible-option,ansible-return-value --ignore-roles ansopt,ansval,ansretval,ansplugin,ansenvvar,ansenvvarref,ansible-attribute-support-label,ansible-attribute-support-property,ansible-attribute-support-full,ansible-attribute-support-partial,ansible-attribute-support-none,ansible-attribute-support-na,ansible-option-aliases,ansible-option-choices,ansible-option-choices-default-mark,ansible-option-choices-entry,ansible-option-choices-entry-default,ansible-option-configuration,ansible-option-default,ansible-option-default-bold,ansible-option-elements,ansible-option-required,ansible-option-returned-bold,ansible-option-sample-bold,ansible-option-type,ansible-option-versionadded,ansible-rv-sample-value -r "${DEST}" 2>&1 | ( + rstcheck --report-level warning --ignore-directives ansible-links,ansible-option-type-line,ansible-plugin,ansible-requirements-anchor,ansible-role-entrypoint,ansible-attribute,ansible-option,ansible-return-value --ignore-roles ansopt,ansval,ansretval,ansplugin,ansenvvar,ansenvvarref,ansible-attribute-support-label,ansible-attribute-support-property,ansible-attribute-support-full,ansible-attribute-support-partial,ansible-attribute-support-none,ansible-attribute-support-na,ansible-option-aliases,ansible-option-choices,ansible-option-choices-default-mark,ansible-option-choices-entry,ansible-option-choices-entry-default,ansible-option-configuration,ansible-option-default,ansible-option-default-bold,ansible-option-elements,ansible-option-required,ansible-option-returned-bold,ansible-option-sample-bold,ansible-option-type,ansible-option-versionadded,ansible-rv-sample-value -r "${DEST}" 2>&1 | ( set +e grep -v "CRITICAL:rstcheck_core.checker:An \`AttributeError\` error occured." set -e From c88726307f6886202f58a23fe6f9abf0ca4c4bb9 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Tue, 19 Sep 2023 22:37:37 +0200 Subject: [PATCH 3/3] Improve reference titles and parmalink titles. --- .../ansible-docsite/macros/parameters.rst.j2 | 7 ++- .../macros/returnvalues.rst.j2 | 10 ++-- .../docsite/ansible-docsite/plugin.rst.j2 | 20 +++---- src/sphinx_antsibull_ext/directives.py | 59 +++++++++++++++---- .../schemas/ansible_plugin.py | 4 ++ .../collections/ns/col2/foo2_module.rst | 3 - .../collections/ns2/col/bar_filter.rst | 7 ++- .../collections/ns2/col/bar_test.rst | 5 +- .../collections/ns2/col/foo2_module.rst | 3 - .../collections/ns2/col/foo_filter.rst | 5 +- .../collections/ns2/col/foo_lookup.rst | 5 +- .../collections/ns2/col/foo_module.rst | 3 - .../collections/ns2/col/foo_test.rst | 5 +- .../collections/ns2/col/sub.foo3_module.rst | 3 - .../collections/ns2/flatcol/foo2_module.rst | 3 - .../collections/ns2/flatcol/foo_module.rst | 3 - .../collections/ns/col2/foo2_module.rst | 3 - .../collections/ns2/col/bar_filter.rst | 7 ++- .../collections/ns2/col/bar_test.rst | 5 +- .../collections/ns2/col/foo2_module.rst | 3 - .../collections/ns2/col/foo_filter.rst | 5 +- .../collections/ns2/col/foo_lookup.rst | 5 +- .../collections/ns2/col/foo_module.rst | 3 - .../collections/ns2/col/foo_test.rst | 5 +- .../collections/ns2/col/sub.foo3_module.rst | 3 - .../collections/ns2/flatcol/foo2_module.rst | 3 - .../collections/ns2/flatcol/foo_module.rst | 3 - .../collections/ns2/col/bar_filter.rst | 7 ++- .../collections/ns2/col/bar_test.rst | 5 +- .../collections/ns2/col/foo2_module.rst | 3 - .../collections/ns2/col/foo_filter.rst | 5 +- .../collections/ns2/col/foo_lookup.rst | 5 +- .../collections/ns2/col/foo_module.rst | 3 - .../collections/ns2/col/foo_test.rst | 5 +- .../collections/ns2/col/sub.foo3_module.rst | 3 - .../collections/ns2/flatcol/foo2_module.rst | 3 - .../collections/ns2/flatcol/foo_module.rst | 3 - .../baseline-squash-hierarchy/bar_filter.rst | 7 ++- .../baseline-squash-hierarchy/bar_test.rst | 5 +- .../baseline-squash-hierarchy/foo2_module.rst | 3 - .../baseline-squash-hierarchy/foo_filter.rst | 5 +- .../baseline-squash-hierarchy/foo_lookup.rst | 5 +- .../baseline-squash-hierarchy/foo_module.rst | 3 - .../baseline-squash-hierarchy/foo_test.rst | 5 +- .../sub.foo3_module.rst | 3 - 45 files changed, 119 insertions(+), 149 deletions(-) diff --git a/src/antsibull_docs/data/docsite/ansible-docsite/macros/parameters.rst.j2 b/src/antsibull_docs/data/docsite/ansible-docsite/macros/parameters.rst.j2 index afa4525d..11e0ed61 100644 --- a/src/antsibull_docs/data/docsite/ansible-docsite/macros/parameters.rst.j2 +++ b/src/antsibull_docs/data/docsite/ansible-docsite/macros/parameters.rst.j2 @@ -10,7 +10,7 @@ {% from 'macros/deprecates.rst.j2' import in_html as deprecates_html with context %} {% from 'macros/version_added.rst.j2' import version_added_rst, version_added_html %} -{% macro in_rst(elements, suboption_key='suboptions', role_entrypoint=None) %} +{% macro in_rst(elements, suboption_key='suboptions', role_entrypoint=None, special=None) %} .. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: @@ -46,6 +46,9 @@ {% for full_key in value['full_keys'] %} - @{ full_key | antsibull_to_json }@ {% endfor %} +{% if special is not none %} + special: @{ special }@ +{% endif %} .. ansible-option-type-line:: {% if value['aliases'] %} @@ -178,7 +181,7 @@ {##################################################################################################################} -{% macro in_html(elements, suboption_key='suboptions', role_entrypoint=None) %} +{% macro in_html(elements, suboption_key='suboptions', role_entrypoint=None, special=None) %} .. raw:: html diff --git a/src/antsibull_docs/data/docsite/ansible-docsite/macros/returnvalues.rst.j2 b/src/antsibull_docs/data/docsite/ansible-docsite/macros/returnvalues.rst.j2 index 5122ef37..32d8d90e 100644 --- a/src/antsibull_docs/data/docsite/ansible-docsite/macros/returnvalues.rst.j2 +++ b/src/antsibull_docs/data/docsite/ansible-docsite/macros/returnvalues.rst.j2 @@ -8,7 +8,7 @@ {% from 'macros/choiceslist.rst.j2' import in_html as choices_html %} {% from 'macros/version_added.rst.j2' import version_added_rst, version_added_html %} -{% macro in_rst(elements, role_entrypoint=None) %} +{% macro in_rst(elements, role_entrypoint=None, special=None) %} .. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: @@ -44,9 +44,9 @@ {% for full_key in value['full_keys'] %} - @{ full_key | antsibull_to_json }@ {% endfor %} - - .. raw:: html - :url: data:text/plain;base64,IA== +{% if special is not none %} + special: @{ special }@ +{% endif %} .. ansible-option-type-line:: @@ -114,7 +114,7 @@ {##################################################################################################################} -{% macro in_html(elements, role_entrypoint=None) %} +{% macro in_html(elements, role_entrypoint=None, special=None) %} .. raw:: html
diff --git a/src/antsibull_docs/data/docsite/ansible-docsite/plugin.rst.j2 b/src/antsibull_docs/data/docsite/ansible-docsite/plugin.rst.j2 index 16359c10..1e21e090 100644 --- a/src/antsibull_docs/data/docsite/ansible-docsite/plugin.rst.j2 +++ b/src/antsibull_docs/data/docsite/ansible-docsite/plugin.rst.j2 @@ -190,9 +190,9 @@ Terms ----- {% if use_html_blobs %} -@{ parameters_html([['Terms', doc['options']['_terms']]], suboption_key='suboptions') }@ +@{ parameters_html([['Terms', doc['options']['_terms']]], suboption_key='suboptions', special='terms') }@ {% else %} -@{ parameters_rst([['Terms', doc['options']['_terms']]], suboption_key='suboptions') }@ +@{ parameters_rst([['Terms', doc['options']['_terms']]], suboption_key='suboptions', special='terms') }@ {% endif %} {% endif %} @@ -212,9 +212,9 @@ This describes the input of the test, the value before ``is @{plugin_name}@`` or {% endif %} {% if use_html_blobs %} -@{ parameters_html([['Input', doc['options']['_input']]], suboption_key='suboptions') }@ +@{ parameters_html([['Input', doc['options']['_input']]], suboption_key='suboptions', special='input') }@ {% else %} -@{ parameters_rst([['Input', doc['options']['_input']]], suboption_key='suboptions') }@ +@{ parameters_rst([['Input', doc['options']['_input']]], suboption_key='suboptions', special='input') }@ {% endif %} {% endif %} @@ -236,9 +236,9 @@ examples: ``input is @{plugin_name}@(positional1, positional2, ...)`` and ``inpu {% endif %} {% if use_html_blobs %} -@{ parameters_html(doc['options'] | extract_options_from_list(doc['positional'], options_to_ignore=['_input']), suboption_key='suboptions') }@ +@{ parameters_html(doc['options'] | extract_options_from_list(doc['positional'], options_to_ignore=['_input']), suboption_key='suboptions', special='positional') }@ {% else %} -@{ parameters_rst(doc['options'] | extract_options_from_list(doc['positional'], options_to_ignore=['_input']), suboption_key='suboptions') }@ +@{ parameters_rst(doc['options'] | extract_options_from_list(doc['positional'], options_to_ignore=['_input']), suboption_key='suboptions', special='positional') }@ {% endif %} {% endif %} @@ -362,9 +362,9 @@ Returned Facts Facts returned by this module are added/updated in the ``hostvars`` host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them. {% if use_html_blobs %} -@{ return_docs_html(returnfacts | dictsort) }@ +@{ return_docs_html(returnfacts | dictsort, special='facts') }@ {% else %} -@{ return_docs_rst(returnfacts | dictsort) }@ +@{ return_docs_rst(returnfacts | dictsort, special='facts') }@ {% endif %} {% endif %} @@ -383,9 +383,9 @@ Return Value {% if plugin_type in ['lookup', 'filter', 'test'] and returndocs | length == 1 and (returndocs | first).startswith('_') %} {% if use_html_blobs %} -@{ return_docs_html([['Return value', returndocs.values() | first]]) }@ +@{ return_docs_html([['Return value', returndocs.values() | first]], special='return-value') }@ {% else %} -@{ return_docs_rst([['Return value', returndocs.values() | first]]) }@ +@{ return_docs_rst([['Return value', returndocs.values() | first]], special='return-value') }@ {% endif %} {% else %} {% if use_html_blobs %} diff --git a/src/sphinx_antsibull_ext/directives.py b/src/sphinx_antsibull_ext/directives.py index 0085943e..f7a231dc 100644 --- a/src/sphinx_antsibull_ext/directives.py +++ b/src/sphinx_antsibull_ext/directives.py @@ -244,9 +244,8 @@ def _run( rst_id = ( f"ansible_collections.{content.fqcn}_{content.plugin_type}_requirements" ) - ref_title = ( - f"Requirements of the {_plugin_name(content.fqcn, content.plugin_type)}" - ) + 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" @@ -278,13 +277,14 @@ def _run(self, content_str: str, content: AnsibleAttribute) -> list[nodes.Node]: 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(content.fqcn, content.plugin_type)}", + f"{content.name} attribute of {plugin_name}", ) permalink = nodes.raw( "", @@ -309,7 +309,7 @@ def _compile_ids( role_entrypoint: str | None, full_keys: list[list[str]], prefix_type: str, -) -> tuple[dict[str, tuple[str, str]], list[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: @@ -321,7 +321,7 @@ def _compile_ids( 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)) + rst_ids[rst_id] = (html_id, ".".join(full_key), ".".join(full_key[1:])) return rst_ids, _make_unique(html_ids) @@ -342,19 +342,41 @@ def _run(self, content_str: str, content: AnsibleOption) -> list[nodes.Node]: 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) in rst_ids.items(): + 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, - f"{key} option of {_plugin_name(content.fqcn, content.plugin_type)}", + rst_title, ) permalink = nodes.raw( "", f' ', + f' title="Permalink to {what_perma}">', format="html", ) return [node, permalink] @@ -377,19 +399,32 @@ def _run(self, content_str: str, content: AnsibleReturnValue) -> list[nodes.Node 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) in rst_ids.items(): + 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, - f"{key} return value of {_plugin_name(content.fqcn, content.plugin_type)}", + ref_title, ) permalink = nodes.raw( "", f' ', + f' title="Permalink to {what_perma}">', format="html", ) return [node, permalink] diff --git a/src/sphinx_antsibull_ext/schemas/ansible_plugin.py b/src/sphinx_antsibull_ext/schemas/ansible_plugin.py index b941dd57..2f6a2cc2 100644 --- a/src/sphinx_antsibull_ext/schemas/ansible_plugin.py +++ b/src/sphinx_antsibull_ext/schemas/ansible_plugin.py @@ -47,6 +47,9 @@ class AnsibleOption(p.BaseModel): 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): @@ -55,3 +58,4 @@ class AnsibleReturnValue(p.BaseModel): 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/foo2_module.rst b/tests/functional/baseline-default/collections/ns/col2/foo2_module.rst index a2fa8751..83d3e6f1 100644 --- a/tests/functional/baseline-default/collections/ns/col2/foo2_module.rst +++ b/tests/functional/baseline-default/collections/ns/col2/foo2_module.rst @@ -488,9 +488,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string` 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 812a6fb5..02c0f5dd 100644 --- a/tests/functional/baseline-default/collections/ns2/col/bar_filter.rst +++ b/tests/functional/baseline-default/collections/ns2/col/bar_filter.rst @@ -98,6 +98,7 @@ This describes the input of the filter, the value before ``| ns2.col.bar``. name: "Input" full_keys: - ["_input"] + special: input .. ansible-option-type-line:: @@ -154,6 +155,7 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)`` name: "foo" full_keys: - ["foo"] + special: positional .. ansible-option-type-line:: @@ -188,6 +190,7 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)`` name: "bar" full_keys: - ["bar"] + special: positional .. ansible-option-type-line:: @@ -353,9 +356,7 @@ Return Value name: "Return value" full_keys: - ["_value"] - - .. raw:: html - :url: data:text/plain;base64,IA== + 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 f4543b19..5b6d4b71 100644 --- a/tests/functional/baseline-default/collections/ns2/col/bar_test.rst +++ b/tests/functional/baseline-default/collections/ns2/col/bar_test.rst @@ -96,6 +96,7 @@ This describes the input of the test, the value before ``is ns2.col.bar`` or ``i name: "Input" full_keys: - ["_input"] + special: input .. ansible-option-type-line:: @@ -176,9 +177,7 @@ Return Value name: "Return value" full_keys: - ["_value"] - - .. raw:: html - :url: data:text/plain;base64,IA== + 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 95c8a112..27ace73c 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo2_module.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo2_module.rst @@ -339,9 +339,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string` 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 bd580cf7..1e13419a 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_filter.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_filter.rst @@ -98,6 +98,7 @@ This describes the input of the filter, the value before ``| ns2.col.foo``. name: "Input" full_keys: - ["_input"] + special: input .. ansible-option-type-line:: @@ -264,9 +265,7 @@ Return Value name: "Return value" full_keys: - ["_value"] - - .. raw:: html - :url: data:text/plain;base64,IA== + special: return-value .. 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 3ab43d85..39baa675 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_lookup.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_lookup.rst @@ -96,6 +96,7 @@ Terms name: "Terms" full_keys: - ["_terms"] + special: terms .. ansible-option-type-line:: @@ -237,9 +238,7 @@ Return Value name: "Return value" full_keys: - ["_raw"] - - .. raw:: html - :url: data:text/plain;base64,IA== + 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 97d5ee02..c47f1926 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_module.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_module.rst @@ -490,9 +490,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string` 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 de21ce8f..9bec8320 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_test.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_test.rst @@ -95,6 +95,7 @@ This describes the input of the test, the value before ``is ns2.col.foo`` or ``i name: "Input" full_keys: - ["_input"] + special: input .. ansible-option-type-line:: @@ -227,9 +228,7 @@ Return Value name: "Return value" full_keys: - ["_value"] - - .. raw:: html - :url: data:text/plain;base64,IA== + special: return-value .. ansible-option-type-line:: 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 b48ab50f..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 @@ -338,9 +338,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string` 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 2e3a8e6a..22ccc905 100644 --- a/tests/functional/baseline-default/collections/ns2/flatcol/foo2_module.rst +++ b/tests/functional/baseline-default/collections/ns2/flatcol/foo2_module.rst @@ -173,9 +173,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string` 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 0389d79c..0542d34a 100644 --- a/tests/functional/baseline-default/collections/ns2/flatcol/foo_module.rst +++ b/tests/functional/baseline-default/collections/ns2/flatcol/foo_module.rst @@ -308,9 +308,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string` 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 a2fa8751..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 @@ -488,9 +488,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string` 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 812a6fb5..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 @@ -98,6 +98,7 @@ This describes the input of the filter, the value before ``| ns2.col.bar``. name: "Input" full_keys: - ["_input"] + special: input .. ansible-option-type-line:: @@ -154,6 +155,7 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)`` name: "foo" full_keys: - ["foo"] + special: positional .. ansible-option-type-line:: @@ -188,6 +190,7 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)`` name: "bar" full_keys: - ["bar"] + special: positional .. ansible-option-type-line:: @@ -353,9 +356,7 @@ Return Value name: "Return value" full_keys: - ["_value"] - - .. raw:: html - :url: data:text/plain;base64,IA== + 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 f4543b19..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 @@ -96,6 +96,7 @@ This describes the input of the test, the value before ``is ns2.col.bar`` or ``i name: "Input" full_keys: - ["_input"] + special: input .. ansible-option-type-line:: @@ -176,9 +177,7 @@ Return Value name: "Return value" full_keys: - ["_value"] - - .. raw:: html - :url: data:text/plain;base64,IA== + 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 95c8a112..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 @@ -339,9 +339,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string` 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 bd580cf7..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 @@ -98,6 +98,7 @@ This describes the input of the filter, the value before ``| ns2.col.foo``. name: "Input" full_keys: - ["_input"] + special: input .. ansible-option-type-line:: @@ -264,9 +265,7 @@ Return Value name: "Return value" full_keys: - ["_value"] - - .. raw:: html - :url: data:text/plain;base64,IA== + special: return-value .. 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 3ab43d85..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 @@ -96,6 +96,7 @@ Terms name: "Terms" full_keys: - ["_terms"] + special: terms .. ansible-option-type-line:: @@ -237,9 +238,7 @@ Return Value name: "Return value" full_keys: - ["_raw"] - - .. raw:: html - :url: data:text/plain;base64,IA== + 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 97d5ee02..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 @@ -490,9 +490,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string` 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 de21ce8f..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 @@ -95,6 +95,7 @@ This describes the input of the test, the value before ``is ns2.col.foo`` or ``i name: "Input" full_keys: - ["_input"] + special: input .. ansible-option-type-line:: @@ -227,9 +228,7 @@ Return Value name: "Return value" full_keys: - ["_value"] - - .. raw:: html - :url: data:text/plain;base64,IA== + special: return-value .. ansible-option-type-line:: 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 b48ab50f..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 @@ -338,9 +338,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string` 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 2e3a8e6a..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 @@ -173,9 +173,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string` 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 0389d79c..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 @@ -308,9 +308,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string` 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 812a6fb5..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 @@ -98,6 +98,7 @@ This describes the input of the filter, the value before ``| ns2.col.bar``. name: "Input" full_keys: - ["_input"] + special: input .. ansible-option-type-line:: @@ -154,6 +155,7 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)`` name: "foo" full_keys: - ["foo"] + special: positional .. ansible-option-type-line:: @@ -188,6 +190,7 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)`` name: "bar" full_keys: - ["bar"] + special: positional .. ansible-option-type-line:: @@ -353,9 +356,7 @@ Return Value name: "Return value" full_keys: - ["_value"] - - .. raw:: html - :url: data:text/plain;base64,IA== + 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 f4543b19..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 @@ -96,6 +96,7 @@ This describes the input of the test, the value before ``is ns2.col.bar`` or ``i name: "Input" full_keys: - ["_input"] + special: input .. ansible-option-type-line:: @@ -176,9 +177,7 @@ Return Value name: "Return value" full_keys: - ["_value"] - - .. raw:: html - :url: data:text/plain;base64,IA== + 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 95c8a112..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 @@ -339,9 +339,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string` 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 bd580cf7..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 @@ -98,6 +98,7 @@ This describes the input of the filter, the value before ``| ns2.col.foo``. name: "Input" full_keys: - ["_input"] + special: input .. ansible-option-type-line:: @@ -264,9 +265,7 @@ Return Value name: "Return value" full_keys: - ["_value"] - - .. raw:: html - :url: data:text/plain;base64,IA== + special: return-value .. 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 3ab43d85..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 @@ -96,6 +96,7 @@ Terms name: "Terms" full_keys: - ["_terms"] + special: terms .. ansible-option-type-line:: @@ -237,9 +238,7 @@ Return Value name: "Return value" full_keys: - ["_raw"] - - .. raw:: html - :url: data:text/plain;base64,IA== + 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 97d5ee02..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 @@ -490,9 +490,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string` 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 de21ce8f..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 @@ -95,6 +95,7 @@ This describes the input of the test, the value before ``is ns2.col.foo`` or ``i name: "Input" full_keys: - ["_input"] + special: input .. ansible-option-type-line:: @@ -227,9 +228,7 @@ Return Value name: "Return value" full_keys: - ["_value"] - - .. raw:: html - :url: data:text/plain;base64,IA== + special: return-value .. ansible-option-type-line:: 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 b48ab50f..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 @@ -338,9 +338,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string` 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 2e3a8e6a..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 @@ -173,9 +173,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string` 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 0389d79c..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 @@ -308,9 +308,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string` diff --git a/tests/functional/baseline-squash-hierarchy/bar_filter.rst b/tests/functional/baseline-squash-hierarchy/bar_filter.rst index 812a6fb5..02c0f5dd 100644 --- a/tests/functional/baseline-squash-hierarchy/bar_filter.rst +++ b/tests/functional/baseline-squash-hierarchy/bar_filter.rst @@ -98,6 +98,7 @@ This describes the input of the filter, the value before ``| ns2.col.bar``. name: "Input" full_keys: - ["_input"] + special: input .. ansible-option-type-line:: @@ -154,6 +155,7 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)`` name: "foo" full_keys: - ["foo"] + special: positional .. ansible-option-type-line:: @@ -188,6 +190,7 @@ example: ``input | ns2.col.bar(positional1, positional2, ...)`` name: "bar" full_keys: - ["bar"] + special: positional .. ansible-option-type-line:: @@ -353,9 +356,7 @@ Return Value name: "Return value" full_keys: - ["_value"] - - .. raw:: html - :url: data:text/plain;base64,IA== + special: return-value .. ansible-option-type-line:: diff --git a/tests/functional/baseline-squash-hierarchy/bar_test.rst b/tests/functional/baseline-squash-hierarchy/bar_test.rst index f4543b19..5b6d4b71 100644 --- a/tests/functional/baseline-squash-hierarchy/bar_test.rst +++ b/tests/functional/baseline-squash-hierarchy/bar_test.rst @@ -96,6 +96,7 @@ This describes the input of the test, the value before ``is ns2.col.bar`` or ``i name: "Input" full_keys: - ["_input"] + special: input .. ansible-option-type-line:: @@ -176,9 +177,7 @@ Return Value name: "Return value" full_keys: - ["_value"] - - .. raw:: html - :url: data:text/plain;base64,IA== + special: return-value .. ansible-option-type-line:: diff --git a/tests/functional/baseline-squash-hierarchy/foo2_module.rst b/tests/functional/baseline-squash-hierarchy/foo2_module.rst index 95c8a112..27ace73c 100644 --- a/tests/functional/baseline-squash-hierarchy/foo2_module.rst +++ b/tests/functional/baseline-squash-hierarchy/foo2_module.rst @@ -339,9 +339,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string` diff --git a/tests/functional/baseline-squash-hierarchy/foo_filter.rst b/tests/functional/baseline-squash-hierarchy/foo_filter.rst index bd580cf7..1e13419a 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_filter.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_filter.rst @@ -98,6 +98,7 @@ This describes the input of the filter, the value before ``| ns2.col.foo``. name: "Input" full_keys: - ["_input"] + special: input .. ansible-option-type-line:: @@ -264,9 +265,7 @@ Return Value name: "Return value" full_keys: - ["_value"] - - .. raw:: html - :url: data:text/plain;base64,IA== + special: return-value .. ansible-option-type-line:: diff --git a/tests/functional/baseline-squash-hierarchy/foo_lookup.rst b/tests/functional/baseline-squash-hierarchy/foo_lookup.rst index 3ab43d85..39baa675 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_lookup.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_lookup.rst @@ -96,6 +96,7 @@ Terms name: "Terms" full_keys: - ["_terms"] + special: terms .. ansible-option-type-line:: @@ -237,9 +238,7 @@ Return Value name: "Return value" full_keys: - ["_raw"] - - .. raw:: html - :url: data:text/plain;base64,IA== + special: return-value .. ansible-option-type-line:: diff --git a/tests/functional/baseline-squash-hierarchy/foo_module.rst b/tests/functional/baseline-squash-hierarchy/foo_module.rst index 97d5ee02..c47f1926 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_module.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_module.rst @@ -490,9 +490,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string` diff --git a/tests/functional/baseline-squash-hierarchy/foo_test.rst b/tests/functional/baseline-squash-hierarchy/foo_test.rst index de21ce8f..9bec8320 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_test.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_test.rst @@ -95,6 +95,7 @@ This describes the input of the test, the value before ``is ns2.col.foo`` or ``i name: "Input" full_keys: - ["_input"] + special: input .. ansible-option-type-line:: @@ -227,9 +228,7 @@ Return Value name: "Return value" full_keys: - ["_value"] - - .. raw:: html - :url: data:text/plain;base64,IA== + special: return-value .. ansible-option-type-line:: diff --git a/tests/functional/baseline-squash-hierarchy/sub.foo3_module.rst b/tests/functional/baseline-squash-hierarchy/sub.foo3_module.rst index b48ab50f..f01c5e54 100644 --- a/tests/functional/baseline-squash-hierarchy/sub.foo3_module.rst +++ b/tests/functional/baseline-squash-hierarchy/sub.foo3_module.rst @@ -338,9 +338,6 @@ Common return values are documented :ref:`here `, the foll full_keys: - ["bar"] - .. raw:: html - :url: data:text/plain;base64,IA== - .. ansible-option-type-line:: :ansible-option-type:`string`