diff --git a/src/antsibull_docs/data/docsite/list_of_callback_plugins.rst.j2 b/src/antsibull_docs/data/docsite/list_of_callback_plugins.rst.j2 index 13b26267..81259f01 100644 --- a/src/antsibull_docs/data/docsite/list_of_callback_plugins.rst.j2 +++ b/src/antsibull_docs/data/docsite/list_of_callback_plugins.rst.j2 @@ -18,7 +18,7 @@ See :ref:`list_of_callback_plugins` for the list of *all* callback plugins. @{ '-' * (collection_name | length) }@ {% for plugin_name, plugin_desc in plugins.items() | sort %} -* :ref:`@{ collection_name }@.@{ plugin_name }@ ` -- @{ plugin_desc | rst_ify }@ +* :ref:`@{ collection_name }@.@{ plugin_name }@ ` -- @{ plugin_desc | rst_ify(plugin_fqcn=collection_name ~ '.' ~ plugin_name, plugin_type='callback') }@ {% endfor %} {% else %} diff --git a/src/antsibull_docs/data/docsite/list_of_env_variables.rst.j2 b/src/antsibull_docs/data/docsite/list_of_env_variables.rst.j2 index 12ff8949..6d6f27a0 100644 --- a/src/antsibull_docs/data/docsite/list_of_env_variables.rst.j2 +++ b/src/antsibull_docs/data/docsite/list_of_env_variables.rst.j2 @@ -19,7 +19,7 @@ Environment variables used by the ansible-core configuration are documented in : .. envvar:: @{ env_var.name }@ {% for paragraph in env_var.description or [] %} - @{ paragraph | replace('\n', '\n ') | rst_ify | indent(4) }@ + @{ paragraph | replace('\n', '\n ') | rst_ify(plugin_fqcn='', plugin_type='') | indent(4) }@ {% endfor %} *Used by:* diff --git a/src/antsibull_docs/data/docsite/list_of_plugins.rst.j2 b/src/antsibull_docs/data/docsite/list_of_plugins.rst.j2 index 985bcdfc..3fd334af 100644 --- a/src/antsibull_docs/data/docsite/list_of_plugins.rst.j2 +++ b/src/antsibull_docs/data/docsite/list_of_plugins.rst.j2 @@ -34,7 +34,7 @@ Index of all @{ plugin_type | capitalize }@ Plugins @{ '-' * (collection_name | length) }@ {% for plugin_name, plugin_desc in plugins.items() | sort %} -* :ref:`@{ collection_name }@.@{ plugin_name }@ ` -- @{ plugin_desc | rst_ify }@ +* :ref:`@{ collection_name }@.@{ plugin_name }@ ` -- @{ plugin_desc | rst_ify(plugin_fqcn=collection_name ~ '.' ~ plugin_name, plugin_type=plugin_type) }@ {% endfor %} {% endfor %} diff --git a/src/antsibull_docs/data/docsite/plugins_by_collection.rst.j2 b/src/antsibull_docs/data/docsite/plugins_by_collection.rst.j2 index 10b4a388..d4a84cee 100644 --- a/src/antsibull_docs/data/docsite/plugins_by_collection.rst.j2 +++ b/src/antsibull_docs/data/docsite/plugins_by_collection.rst.j2 @@ -10,7 +10,7 @@ {% macro list_plugins(plugin_type) %} {% for name, desc in plugin_maps[plugin_type].items() | sort %} -* :ref:`@{ name }@ @{ plugin_type }@ ` -- @{ desc | rst_ify | indent(width=2) }@ +* :ref:`@{ name }@ @{ plugin_type }@ ` -- @{ desc | rst_ify(plugin_fqcn=collection_name ~ '.' ~ name, plugin_type=plugin_type) | indent(width=2) }@ {% endfor %} {% if breadcrumbs %} diff --git a/src/antsibull_docs/jinja2/filters.py b/src/antsibull_docs/jinja2/filters.py index 4b050d23..ee20ca51 100644 --- a/src/antsibull_docs/jinja2/filters.py +++ b/src/antsibull_docs/jinja2/filters.py @@ -19,9 +19,12 @@ _EMAIL_ADDRESS = re.compile(r"(?:<{mail}>|\({mail}\)|{mail})".format(mail=r"[\w.+-]+@[\w.-]+\.\w+")) -def extract_plugin_data(context: Context) -> t.Tuple[t.Optional[str], t.Optional[str]]: - plugin_fqcn = context.get('plugin_name') - plugin_type = context.get('plugin_type') +def extract_plugin_data(context: Context, + plugin_fqcn: t.Optional[str] = None, + plugin_type: t.Optional[str] = None + ) -> t.Tuple[t.Optional[str], t.Optional[str]]: + plugin_fqcn = context.get('plugin_name') if plugin_fqcn is None else plugin_fqcn + plugin_type = context.get('plugin_type') if plugin_type is None else plugin_type if plugin_fqcn is None or plugin_type is None: return None, None # if plugin_type == 'role': diff --git a/src/antsibull_docs/jinja2/htmlify.py b/src/antsibull_docs/jinja2/htmlify.py index 25578c1c..5cf8956d 100644 --- a/src/antsibull_docs/jinja2/htmlify.py +++ b/src/antsibull_docs/jinja2/htmlify.py @@ -42,7 +42,9 @@ class _Context: plugin_fqcn: t.Optional[str] plugin_type: t.Optional[str] - def __init__(self, j2_context: Context): + def __init__(self, j2_context: Context, + plugin_fqcn: t.Optional[str] = None, + plugin_type: t.Optional[str] = None): self.j2_context = j2_context self.counts = { 'italic': 0, @@ -59,7 +61,8 @@ def __init__(self, j2_context: Context): 'return-value': 0, 'ruler': 0, } - self.plugin_fqcn, self.plugin_type = extract_plugin_data(j2_context) + self.plugin_fqcn, self.plugin_type = extract_plugin_data( + j2_context, plugin_fqcn=plugin_fqcn, plugin_type=plugin_type) # In the following, we make heavy use of escaped whitespace ("\ ") being removed from the output. @@ -295,12 +298,19 @@ def handle(self, parameters: t.List[str], context: t.Any) -> str: @pass_context -def html_ify(context: Context, text: str) -> str: +def html_ify(context: Context, text: str, + *, + plugin_fqcn: t.Optional[str] = None, + plugin_type: t.Optional[str] = None) -> str: ''' convert symbols like I(this is in italics) to valid HTML ''' flog = mlog.fields(func='html_ify') flog.fields(text=text).debug('Enter') - our_context = _Context(context) + our_context = _Context( + context, + plugin_fqcn=plugin_fqcn, + plugin_type=plugin_type, + ) try: text = convert_text(text, _COMMAND_SET, html_escape, our_context) diff --git a/src/antsibull_docs/jinja2/rstify.py b/src/antsibull_docs/jinja2/rstify.py index 21a3879b..865026be 100644 --- a/src/antsibull_docs/jinja2/rstify.py +++ b/src/antsibull_docs/jinja2/rstify.py @@ -70,7 +70,9 @@ class _Context: plugin_fqcn: t.Optional[str] plugin_type: t.Optional[str] - def __init__(self, j2_context: Context): + def __init__(self, j2_context: Context, + plugin_fqcn: t.Optional[str] = None, + plugin_type: t.Optional[str] = None): self.j2_context = j2_context self.counts = { 'italic': 0, @@ -87,7 +89,8 @@ def __init__(self, j2_context: Context): 'return-value': 0, 'ruler': 0, } - self.plugin_fqcn, self.plugin_type = extract_plugin_data(j2_context) + self.plugin_fqcn, self.plugin_type = extract_plugin_data( + j2_context, plugin_fqcn=plugin_fqcn, plugin_type=plugin_type) # In the following, we make heavy use of escaped whitespace ("\ ") being removed from the output. @@ -263,12 +266,19 @@ def handle(self, parameters: t.List[str], context: t.Any) -> str: @pass_context -def rst_ify(context: Context, text: str) -> str: +def rst_ify(context: Context, text: str, + *, + plugin_fqcn: t.Optional[str] = None, + plugin_type: t.Optional[str] = None) -> str: ''' convert symbols like I(this is in italics) to valid restructured text ''' flog = mlog.fields(func='rst_ify') flog.fields(text=text).debug('Enter') - our_context = _Context(context) + our_context = _Context( + context, + plugin_fqcn=plugin_fqcn, + plugin_type=plugin_type, + ) try: text = convert_text(text, _COMMAND_SET, rst_escape, our_context) diff --git a/tests/functional/baseline-default/collections/callback_index_stdout.rst b/tests/functional/baseline-default/collections/callback_index_stdout.rst index bf8507ee..eb1be590 100644 --- a/tests/functional/baseline-default/collections/callback_index_stdout.rst +++ b/tests/functional/baseline-default/collections/callback_index_stdout.rst @@ -11,5 +11,5 @@ See :ref:`list_of_callback_plugins` for the list of *all* callback plugins. ns2.col ------- -* :ref:`ns2.col.foo ` -- Foo output +* :ref:`ns2.col.foo ` -- Foo output \ :ansopt:`ns2.col.foo#callback:bar`\ diff --git a/tests/functional/baseline-default/collections/index_become.rst b/tests/functional/baseline-default/collections/index_become.rst index 2164fbe4..22320c90 100644 --- a/tests/functional/baseline-default/collections/index_become.rst +++ b/tests/functional/baseline-default/collections/index_become.rst @@ -9,5 +9,5 @@ Index of all Become Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Use foo +* :ref:`ns2.col.foo ` -- Use foo \ :ansopt:`ns2.col.foo#become:bar`\ diff --git a/tests/functional/baseline-default/collections/index_cache.rst b/tests/functional/baseline-default/collections/index_cache.rst index 66467af5..7a9d56a0 100644 --- a/tests/functional/baseline-default/collections/index_cache.rst +++ b/tests/functional/baseline-default/collections/index_cache.rst @@ -9,5 +9,5 @@ Index of all Cache Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Foo files +* :ref:`ns2.col.foo ` -- Foo files \ :ansopt:`ns2.col.foo#cache:bar`\ diff --git a/tests/functional/baseline-default/collections/index_callback.rst b/tests/functional/baseline-default/collections/index_callback.rst index c982c8ae..0c297f89 100644 --- a/tests/functional/baseline-default/collections/index_callback.rst +++ b/tests/functional/baseline-default/collections/index_callback.rst @@ -17,5 +17,5 @@ Index of all Callback Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Foo output +* :ref:`ns2.col.foo ` -- Foo output \ :ansopt:`ns2.col.foo#callback:bar`\ diff --git a/tests/functional/baseline-default/collections/index_connection.rst b/tests/functional/baseline-default/collections/index_connection.rst index 7100cdd4..2d2fe2e1 100644 --- a/tests/functional/baseline-default/collections/index_connection.rst +++ b/tests/functional/baseline-default/collections/index_connection.rst @@ -9,5 +9,5 @@ Index of all Connection Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Foo connection +* :ref:`ns2.col.foo ` -- Foo connection \ :ansopt:`ns2.col.foo#connection:bar`\ diff --git a/tests/functional/baseline-default/collections/index_filter.rst b/tests/functional/baseline-default/collections/index_filter.rst index be6417ab..e8733ee6 100644 --- a/tests/functional/baseline-default/collections/index_filter.rst +++ b/tests/functional/baseline-default/collections/index_filter.rst @@ -9,5 +9,5 @@ Index of all Filter Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- The foo filter +* :ref:`ns2.col.foo ` -- The foo filter \ :ansopt:`ns2.col.foo#filter:bar`\ diff --git a/tests/functional/baseline-default/collections/index_inventory.rst b/tests/functional/baseline-default/collections/index_inventory.rst index 792627ef..82638b0e 100644 --- a/tests/functional/baseline-default/collections/index_inventory.rst +++ b/tests/functional/baseline-default/collections/index_inventory.rst @@ -9,5 +9,5 @@ Index of all Inventory Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- The foo inventory +* :ref:`ns2.col.foo ` -- The foo inventory \ :ansopt:`ns2.col.foo#inventory:bar`\ diff --git a/tests/functional/baseline-default/collections/index_lookup.rst b/tests/functional/baseline-default/collections/index_lookup.rst index 2550951c..0643d7a6 100644 --- a/tests/functional/baseline-default/collections/index_lookup.rst +++ b/tests/functional/baseline-default/collections/index_lookup.rst @@ -9,5 +9,5 @@ Index of all Lookup Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Look up some foo +* :ref:`ns2.col.foo ` -- Look up some foo \ :ansopt:`ns2.col.foo#lookup:bar`\ diff --git a/tests/functional/baseline-default/collections/index_module.rst b/tests/functional/baseline-default/collections/index_module.rst index 31f649bb..76f68b20 100644 --- a/tests/functional/baseline-default/collections/index_module.rst +++ b/tests/functional/baseline-default/collections/index_module.rst @@ -14,6 +14,6 @@ ns.col2 ns2.col ------- -* :ref:`ns2.col.foo ` -- Do some foo +* :ref:`ns2.col.foo ` -- Do some foo \ :ansopt:`ns2.col.foo#module:bar`\ * :ref:`ns2.col.foo2 ` -- Another foo diff --git a/tests/functional/baseline-default/collections/index_shell.rst b/tests/functional/baseline-default/collections/index_shell.rst index 4f3cc8a7..4199a913 100644 --- a/tests/functional/baseline-default/collections/index_shell.rst +++ b/tests/functional/baseline-default/collections/index_shell.rst @@ -9,5 +9,5 @@ Index of all Shell Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Foo shell +* :ref:`ns2.col.foo ` -- Foo shell \ :ansopt:`ns2.col.foo#shell:bar`\ diff --git a/tests/functional/baseline-default/collections/index_test.rst b/tests/functional/baseline-default/collections/index_test.rst index 876cd1f4..775fd6e8 100644 --- a/tests/functional/baseline-default/collections/index_test.rst +++ b/tests/functional/baseline-default/collections/index_test.rst @@ -9,5 +9,5 @@ Index of all Test Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Is something a foo +* :ref:`ns2.col.foo ` -- Is something a foo \ :ansopt:`ns2.col.foo#test:bar`\ diff --git a/tests/functional/baseline-default/collections/index_vars.rst b/tests/functional/baseline-default/collections/index_vars.rst index 16ea4aba..112eaaac 100644 --- a/tests/functional/baseline-default/collections/index_vars.rst +++ b/tests/functional/baseline-default/collections/index_vars.rst @@ -9,5 +9,5 @@ Index of all Vars Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Load foo +* :ref:`ns2.col.foo ` -- Load foo \ :ansopt:`ns2.col.foo#vars:bar`\ 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 377870ca..a497ffb2 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_become.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_become.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo become -- Use foo -+++++++++++++++++++++++++++++ +ns2.col.foo become -- Use foo \ :ansopt:`ns2.col.foo#become:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note 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 219ae0f6..a8d6c718 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_cache.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_cache.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo cache -- Foo files -++++++++++++++++++++++++++++++ +ns2.col.foo cache -- Foo files \ :ansopt:`ns2.col.foo#cache:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -144,6 +144,43 @@ Parameters - Environment variable: :envvar:`ANSIBLE\_CACHE\_PLUGIN\_CONNECTION` + .. raw:: html + + + + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_cache__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Nothing. + + .. raw:: html
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 0a05f01f..f164ab6b 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_callback.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_callback.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo callback -- Foo output -++++++++++++++++++++++++++++++++++ +ns2.col.foo callback -- Foo output \ :ansopt:`ns2.col.foo#callback:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -88,6 +88,57 @@ Synopsis .. Options +Parameters +---------- + + +.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_callback__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Nothing. + + + .. raw:: html + +
+ .. Attributes 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 d86619d4..fe063648 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_connection.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_connection.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo connection -- Foo connection -++++++++++++++++++++++++++++++++++++++++ +ns2.col.foo connection -- Foo connection \ :ansopt:`ns2.col.foo#connection:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -96,6 +96,43 @@ Parameters * - Parameter - Comments + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_connection__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ * - .. raw:: html
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 fe22438a..cae67ce3 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_filter.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_filter.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo filter -- The foo filter -++++++++++++++++++++++++++++++++++++ +ns2.col.foo filter -- The foo filter \ :ansopt:`ns2.col.foo#filter:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -153,6 +153,43 @@ This describes keyword parameters of the filter. These are the values ``key1=val * - Parameter - Comments + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_filter__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Some bar. + + + .. raw:: html + +
+ * - .. raw:: html
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 05b86c02..50aeb71f 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_inventory.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_inventory.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo inventory -- The foo inventory -++++++++++++++++++++++++++++++++++++++++++ +ns2.col.foo inventory -- The foo inventory \ :ansopt:`ns2.col.foo#inventory:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -82,6 +82,57 @@ Synopsis .. Options +Parameters +---------- + + +.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_inventory__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ .. Attributes 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 a48b569b..308a2d7f 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_lookup.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_lookup.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo lookup -- Look up some foo -++++++++++++++++++++++++++++++++++++++ +ns2.col.foo lookup -- Look up some foo \ :ansopt:`ns2.col.foo#lookup:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -137,6 +137,57 @@ Terms .. Options +Parameters +---------- + + +.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_lookup__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ .. Attributes 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 20f89a55..27ec6c5a 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_module.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_module.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo module -- Do some foo -+++++++++++++++++++++++++++++++++ +ns2.col.foo module -- Do some foo \ :ansopt:`ns2.col.foo#module:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -463,7 +463,7 @@ See Also \ :ref:`ns2.col.foo3 `\ The official documentation on the **ns2.col.foo3** module. \ :ref:`ns2.col.foo `\ lookup plugin - Look up some foo. + Look up some foo \ :ansopt:`ns2.col.foo#module:bar`\ . .. Examples 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 8ed400f9..0148361b 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_shell.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_shell.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo shell -- Foo shell -++++++++++++++++++++++++++++++ +ns2.col.foo shell -- Foo shell \ :ansopt:`ns2.col.foo#shell:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -96,6 +96,43 @@ Parameters * - Parameter - Comments + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_shell__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ * - .. raw:: html
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 e2712977..085b587f 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_test.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_test.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo test -- Is something a foo -++++++++++++++++++++++++++++++++++++++ +ns2.col.foo test -- Is something a foo \ :ansopt:`ns2.col.foo#test:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -135,6 +135,58 @@ This describes the input of the test, the value before ``is ns2.col.foo`` or ``i .. Options +Keyword parameters +------------------ + +This describes keyword parameters of the test. These are the values ``key1=value1``, ``key2=value2`` and so on in the following examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is not ns2.col.foo(key1=value1, key2=value2, ...)``. + +.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_test__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ .. Attributes 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 0df3babc..57fb56d4 100644 --- a/tests/functional/baseline-default/collections/ns2/col/foo_vars.rst +++ b/tests/functional/baseline-default/collections/ns2/col/foo_vars.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo vars -- Load foo -++++++++++++++++++++++++++++ +ns2.col.foo vars -- Load foo \ :ansopt:`ns2.col.foo#vars:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -159,6 +159,43 @@ Parameters - Environment variable: :envvar:`ANSIBLE\_FOO\_FILENAME\_EXT` + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_vars__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + .. raw:: html
diff --git a/tests/functional/baseline-default/collections/ns2/col/index.rst b/tests/functional/baseline-default/collections/ns2/col/index.rst index 4b16b946..57911fb0 100644 --- a/tests/functional/baseline-default/collections/ns2/col/index.rst +++ b/tests/functional/baseline-default/collections/ns2/col/index.rst @@ -74,7 +74,7 @@ These are the plugins in the ns2.col collection: Modules ~~~~~~~ -* :ref:`foo module ` -- Do some foo +* :ref:`foo module ` -- Do some foo \ :ansopt:`ns2.col.foo#module:bar`\ * :ref:`foo2 module ` -- Another foo .. toctree:: @@ -88,7 +88,7 @@ Modules Become Plugins ~~~~~~~~~~~~~~ -* :ref:`foo become ` -- Use foo +* :ref:`foo become ` -- Use foo \ :ansopt:`ns2.col.foo#become:bar`\ .. toctree:: :maxdepth: 1 @@ -100,7 +100,7 @@ Become Plugins Cache Plugins ~~~~~~~~~~~~~ -* :ref:`foo cache ` -- Foo files +* :ref:`foo cache ` -- Foo files \ :ansopt:`ns2.col.foo#cache:bar`\ .. toctree:: :maxdepth: 1 @@ -112,7 +112,7 @@ Cache Plugins Callback Plugins ~~~~~~~~~~~~~~~~ -* :ref:`foo callback ` -- Foo output +* :ref:`foo callback ` -- Foo output \ :ansopt:`ns2.col.foo#callback:bar`\ .. toctree:: :maxdepth: 1 @@ -136,7 +136,7 @@ Cliconf Plugins Connection Plugins ~~~~~~~~~~~~~~~~~~ -* :ref:`foo connection ` -- Foo connection +* :ref:`foo connection ` -- Foo connection \ :ansopt:`ns2.col.foo#connection:bar`\ .. toctree:: :maxdepth: 1 @@ -148,7 +148,7 @@ Connection Plugins Filter Plugins ~~~~~~~~~~~~~~ -* :ref:`foo filter ` -- The foo filter +* :ref:`foo filter ` -- The foo filter \ :ansopt:`ns2.col.foo#filter:bar`\ .. toctree:: :maxdepth: 1 @@ -160,7 +160,7 @@ Filter Plugins Inventory Plugins ~~~~~~~~~~~~~~~~~ -* :ref:`foo inventory ` -- The foo inventory +* :ref:`foo inventory ` -- The foo inventory \ :ansopt:`ns2.col.foo#inventory:bar`\ .. toctree:: :maxdepth: 1 @@ -172,7 +172,7 @@ Inventory Plugins Lookup Plugins ~~~~~~~~~~~~~~ -* :ref:`foo lookup ` -- Look up some foo +* :ref:`foo lookup ` -- Look up some foo \ :ansopt:`ns2.col.foo#lookup:bar`\ .. toctree:: :maxdepth: 1 @@ -184,7 +184,7 @@ Lookup Plugins Shell Plugins ~~~~~~~~~~~~~ -* :ref:`foo shell ` -- Foo shell +* :ref:`foo shell ` -- Foo shell \ :ansopt:`ns2.col.foo#shell:bar`\ .. toctree:: :maxdepth: 1 @@ -208,7 +208,7 @@ Strategy Plugins Test Plugins ~~~~~~~~~~~~ -* :ref:`foo test ` -- Is something a foo +* :ref:`foo test ` -- Is something a foo \ :ansopt:`ns2.col.foo#test:bar`\ .. toctree:: :maxdepth: 1 @@ -220,7 +220,7 @@ Test Plugins Vars Plugins ~~~~~~~~~~~~ -* :ref:`foo vars ` -- Load foo +* :ref:`foo vars ` -- Load foo \ :ansopt:`ns2.col.foo#vars:bar`\ .. toctree:: :maxdepth: 1 diff --git a/tests/functional/baseline-no-breadcrumbs/collections/callback_index_stdout.rst b/tests/functional/baseline-no-breadcrumbs/collections/callback_index_stdout.rst index bf8507ee..eb1be590 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/callback_index_stdout.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/callback_index_stdout.rst @@ -11,5 +11,5 @@ See :ref:`list_of_callback_plugins` for the list of *all* callback plugins. ns2.col ------- -* :ref:`ns2.col.foo ` -- Foo output +* :ref:`ns2.col.foo ` -- Foo output \ :ansopt:`ns2.col.foo#callback:bar`\ diff --git a/tests/functional/baseline-no-breadcrumbs/collections/index_become.rst b/tests/functional/baseline-no-breadcrumbs/collections/index_become.rst index 2164fbe4..22320c90 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/index_become.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/index_become.rst @@ -9,5 +9,5 @@ Index of all Become Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Use foo +* :ref:`ns2.col.foo ` -- Use foo \ :ansopt:`ns2.col.foo#become:bar`\ diff --git a/tests/functional/baseline-no-breadcrumbs/collections/index_cache.rst b/tests/functional/baseline-no-breadcrumbs/collections/index_cache.rst index 66467af5..7a9d56a0 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/index_cache.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/index_cache.rst @@ -9,5 +9,5 @@ Index of all Cache Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Foo files +* :ref:`ns2.col.foo ` -- Foo files \ :ansopt:`ns2.col.foo#cache:bar`\ diff --git a/tests/functional/baseline-no-breadcrumbs/collections/index_callback.rst b/tests/functional/baseline-no-breadcrumbs/collections/index_callback.rst index c982c8ae..0c297f89 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/index_callback.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/index_callback.rst @@ -17,5 +17,5 @@ Index of all Callback Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Foo output +* :ref:`ns2.col.foo ` -- Foo output \ :ansopt:`ns2.col.foo#callback:bar`\ diff --git a/tests/functional/baseline-no-breadcrumbs/collections/index_connection.rst b/tests/functional/baseline-no-breadcrumbs/collections/index_connection.rst index 7100cdd4..2d2fe2e1 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/index_connection.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/index_connection.rst @@ -9,5 +9,5 @@ Index of all Connection Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Foo connection +* :ref:`ns2.col.foo ` -- Foo connection \ :ansopt:`ns2.col.foo#connection:bar`\ diff --git a/tests/functional/baseline-no-breadcrumbs/collections/index_filter.rst b/tests/functional/baseline-no-breadcrumbs/collections/index_filter.rst index be6417ab..e8733ee6 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/index_filter.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/index_filter.rst @@ -9,5 +9,5 @@ Index of all Filter Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- The foo filter +* :ref:`ns2.col.foo ` -- The foo filter \ :ansopt:`ns2.col.foo#filter:bar`\ diff --git a/tests/functional/baseline-no-breadcrumbs/collections/index_inventory.rst b/tests/functional/baseline-no-breadcrumbs/collections/index_inventory.rst index 792627ef..82638b0e 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/index_inventory.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/index_inventory.rst @@ -9,5 +9,5 @@ Index of all Inventory Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- The foo inventory +* :ref:`ns2.col.foo ` -- The foo inventory \ :ansopt:`ns2.col.foo#inventory:bar`\ diff --git a/tests/functional/baseline-no-breadcrumbs/collections/index_lookup.rst b/tests/functional/baseline-no-breadcrumbs/collections/index_lookup.rst index 2550951c..0643d7a6 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/index_lookup.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/index_lookup.rst @@ -9,5 +9,5 @@ Index of all Lookup Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Look up some foo +* :ref:`ns2.col.foo ` -- Look up some foo \ :ansopt:`ns2.col.foo#lookup:bar`\ diff --git a/tests/functional/baseline-no-breadcrumbs/collections/index_module.rst b/tests/functional/baseline-no-breadcrumbs/collections/index_module.rst index 31f649bb..76f68b20 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/index_module.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/index_module.rst @@ -14,6 +14,6 @@ ns.col2 ns2.col ------- -* :ref:`ns2.col.foo ` -- Do some foo +* :ref:`ns2.col.foo ` -- Do some foo \ :ansopt:`ns2.col.foo#module:bar`\ * :ref:`ns2.col.foo2 ` -- Another foo diff --git a/tests/functional/baseline-no-breadcrumbs/collections/index_shell.rst b/tests/functional/baseline-no-breadcrumbs/collections/index_shell.rst index 4f3cc8a7..4199a913 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/index_shell.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/index_shell.rst @@ -9,5 +9,5 @@ Index of all Shell Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Foo shell +* :ref:`ns2.col.foo ` -- Foo shell \ :ansopt:`ns2.col.foo#shell:bar`\ diff --git a/tests/functional/baseline-no-breadcrumbs/collections/index_test.rst b/tests/functional/baseline-no-breadcrumbs/collections/index_test.rst index 876cd1f4..775fd6e8 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/index_test.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/index_test.rst @@ -9,5 +9,5 @@ Index of all Test Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Is something a foo +* :ref:`ns2.col.foo ` -- Is something a foo \ :ansopt:`ns2.col.foo#test:bar`\ diff --git a/tests/functional/baseline-no-breadcrumbs/collections/index_vars.rst b/tests/functional/baseline-no-breadcrumbs/collections/index_vars.rst index 16ea4aba..112eaaac 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/index_vars.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/index_vars.rst @@ -9,5 +9,5 @@ Index of all Vars Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Load foo +* :ref:`ns2.col.foo ` -- Load foo \ :ansopt:`ns2.col.foo#vars:bar`\ 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 377870ca..a497ffb2 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo become -- Use foo -+++++++++++++++++++++++++++++ +ns2.col.foo become -- Use foo \ :ansopt:`ns2.col.foo#become:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note 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 219ae0f6..a8d6c718 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo cache -- Foo files -++++++++++++++++++++++++++++++ +ns2.col.foo cache -- Foo files \ :ansopt:`ns2.col.foo#cache:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -144,6 +144,43 @@ Parameters - Environment variable: :envvar:`ANSIBLE\_CACHE\_PLUGIN\_CONNECTION` + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_cache__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Nothing. + + .. raw:: html
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 0a05f01f..f164ab6b 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo callback -- Foo output -++++++++++++++++++++++++++++++++++ +ns2.col.foo callback -- Foo output \ :ansopt:`ns2.col.foo#callback:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -88,6 +88,57 @@ Synopsis .. Options +Parameters +---------- + + +.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_callback__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Nothing. + + + .. raw:: html + +
+ .. Attributes 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 d86619d4..fe063648 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo connection -- Foo connection -++++++++++++++++++++++++++++++++++++++++ +ns2.col.foo connection -- Foo connection \ :ansopt:`ns2.col.foo#connection:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -96,6 +96,43 @@ Parameters * - Parameter - Comments + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_connection__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ * - .. raw:: html
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 fe22438a..cae67ce3 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo filter -- The foo filter -++++++++++++++++++++++++++++++++++++ +ns2.col.foo filter -- The foo filter \ :ansopt:`ns2.col.foo#filter:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -153,6 +153,43 @@ This describes keyword parameters of the filter. These are the values ``key1=val * - Parameter - Comments + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_filter__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Some bar. + + + .. raw:: html + +
+ * - .. raw:: html
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 05b86c02..50aeb71f 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo inventory -- The foo inventory -++++++++++++++++++++++++++++++++++++++++++ +ns2.col.foo inventory -- The foo inventory \ :ansopt:`ns2.col.foo#inventory:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -82,6 +82,57 @@ Synopsis .. Options +Parameters +---------- + + +.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_inventory__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ .. Attributes 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 a48b569b..308a2d7f 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo lookup -- Look up some foo -++++++++++++++++++++++++++++++++++++++ +ns2.col.foo lookup -- Look up some foo \ :ansopt:`ns2.col.foo#lookup:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -137,6 +137,57 @@ Terms .. Options +Parameters +---------- + + +.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_lookup__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ .. Attributes 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 20f89a55..27ec6c5a 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo module -- Do some foo -+++++++++++++++++++++++++++++++++ +ns2.col.foo module -- Do some foo \ :ansopt:`ns2.col.foo#module:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -463,7 +463,7 @@ See Also \ :ref:`ns2.col.foo3 `\ The official documentation on the **ns2.col.foo3** module. \ :ref:`ns2.col.foo `\ lookup plugin - Look up some foo. + Look up some foo \ :ansopt:`ns2.col.foo#module:bar`\ . .. Examples 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 8ed400f9..0148361b 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo shell -- Foo shell -++++++++++++++++++++++++++++++ +ns2.col.foo shell -- Foo shell \ :ansopt:`ns2.col.foo#shell:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -96,6 +96,43 @@ Parameters * - Parameter - Comments + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_shell__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ * - .. raw:: html
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 e2712977..085b587f 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo test -- Is something a foo -++++++++++++++++++++++++++++++++++++++ +ns2.col.foo test -- Is something a foo \ :ansopt:`ns2.col.foo#test:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -135,6 +135,58 @@ This describes the input of the test, the value before ``is ns2.col.foo`` or ``i .. Options +Keyword parameters +------------------ + +This describes keyword parameters of the test. These are the values ``key1=value1``, ``key2=value2`` and so on in the following examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is not ns2.col.foo(key1=value1, key2=value2, ...)``. + +.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_test__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ .. Attributes 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 0df3babc..57fb56d4 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo vars -- Load foo -++++++++++++++++++++++++++++ +ns2.col.foo vars -- Load foo \ :ansopt:`ns2.col.foo#vars:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -159,6 +159,43 @@ Parameters - Environment variable: :envvar:`ANSIBLE\_FOO\_FILENAME\_EXT` + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_vars__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + .. raw:: html
diff --git a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/index.rst b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/index.rst index 4eed6ed1..606d4ef6 100644 --- a/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/index.rst +++ b/tests/functional/baseline-no-breadcrumbs/collections/ns2/col/index.rst @@ -75,26 +75,26 @@ These are the plugins in the ns2.col collection: Modules ~~~~~~~ -* :ref:`foo module ` -- Do some foo +* :ref:`foo module ` -- Do some foo \ :ansopt:`ns2.col.foo#module:bar`\ * :ref:`foo2 module ` -- Another foo Become Plugins ~~~~~~~~~~~~~~ -* :ref:`foo become ` -- Use foo +* :ref:`foo become ` -- Use foo \ :ansopt:`ns2.col.foo#become:bar`\ Cache Plugins ~~~~~~~~~~~~~ -* :ref:`foo cache ` -- Foo files +* :ref:`foo cache ` -- Foo files \ :ansopt:`ns2.col.foo#cache:bar`\ Callback Plugins ~~~~~~~~~~~~~~~~ -* :ref:`foo callback ` -- Foo output +* :ref:`foo callback ` -- Foo output \ :ansopt:`ns2.col.foo#callback:bar`\ Cliconf Plugins @@ -106,31 +106,31 @@ Cliconf Plugins Connection Plugins ~~~~~~~~~~~~~~~~~~ -* :ref:`foo connection ` -- Foo connection +* :ref:`foo connection ` -- Foo connection \ :ansopt:`ns2.col.foo#connection:bar`\ Filter Plugins ~~~~~~~~~~~~~~ -* :ref:`foo filter ` -- The foo filter +* :ref:`foo filter ` -- The foo filter \ :ansopt:`ns2.col.foo#filter:bar`\ Inventory Plugins ~~~~~~~~~~~~~~~~~ -* :ref:`foo inventory ` -- The foo inventory +* :ref:`foo inventory ` -- The foo inventory \ :ansopt:`ns2.col.foo#inventory:bar`\ Lookup Plugins ~~~~~~~~~~~~~~ -* :ref:`foo lookup ` -- Look up some foo +* :ref:`foo lookup ` -- Look up some foo \ :ansopt:`ns2.col.foo#lookup:bar`\ Shell Plugins ~~~~~~~~~~~~~ -* :ref:`foo shell ` -- Foo shell +* :ref:`foo shell ` -- Foo shell \ :ansopt:`ns2.col.foo#shell:bar`\ Strategy Plugins @@ -142,13 +142,13 @@ Strategy Plugins Test Plugins ~~~~~~~~~~~~ -* :ref:`foo test ` -- Is something a foo +* :ref:`foo test ` -- Is something a foo \ :ansopt:`ns2.col.foo#test:bar`\ Vars Plugins ~~~~~~~~~~~~ -* :ref:`foo vars ` -- Load foo +* :ref:`foo vars ` -- Load foo \ :ansopt:`ns2.col.foo#vars:bar`\ Role Index 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 377870ca..a497ffb2 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo become -- Use foo -+++++++++++++++++++++++++++++ +ns2.col.foo become -- Use foo \ :ansopt:`ns2.col.foo#become:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note 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 219ae0f6..a8d6c718 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo cache -- Foo files -++++++++++++++++++++++++++++++ +ns2.col.foo cache -- Foo files \ :ansopt:`ns2.col.foo#cache:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -144,6 +144,43 @@ Parameters - Environment variable: :envvar:`ANSIBLE\_CACHE\_PLUGIN\_CONNECTION` + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_cache__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Nothing. + + .. raw:: html
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 0a05f01f..f164ab6b 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo callback -- Foo output -++++++++++++++++++++++++++++++++++ +ns2.col.foo callback -- Foo output \ :ansopt:`ns2.col.foo#callback:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -88,6 +88,57 @@ Synopsis .. Options +Parameters +---------- + + +.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_callback__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Nothing. + + + .. raw:: html + +
+ .. Attributes 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 d86619d4..fe063648 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo connection -- Foo connection -++++++++++++++++++++++++++++++++++++++++ +ns2.col.foo connection -- Foo connection \ :ansopt:`ns2.col.foo#connection:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -96,6 +96,43 @@ Parameters * - Parameter - Comments + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_connection__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ * - .. raw:: html
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 fe22438a..cae67ce3 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo filter -- The foo filter -++++++++++++++++++++++++++++++++++++ +ns2.col.foo filter -- The foo filter \ :ansopt:`ns2.col.foo#filter:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -153,6 +153,43 @@ This describes keyword parameters of the filter. These are the values ``key1=val * - Parameter - Comments + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_filter__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Some bar. + + + .. raw:: html + +
+ * - .. raw:: html
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 05b86c02..50aeb71f 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo inventory -- The foo inventory -++++++++++++++++++++++++++++++++++++++++++ +ns2.col.foo inventory -- The foo inventory \ :ansopt:`ns2.col.foo#inventory:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -82,6 +82,57 @@ Synopsis .. Options +Parameters +---------- + + +.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_inventory__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ .. Attributes 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 a48b569b..308a2d7f 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo lookup -- Look up some foo -++++++++++++++++++++++++++++++++++++++ +ns2.col.foo lookup -- Look up some foo \ :ansopt:`ns2.col.foo#lookup:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -137,6 +137,57 @@ Terms .. Options +Parameters +---------- + + +.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_lookup__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ .. Attributes 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 20f89a55..27ec6c5a 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo module -- Do some foo -+++++++++++++++++++++++++++++++++ +ns2.col.foo module -- Do some foo \ :ansopt:`ns2.col.foo#module:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -463,7 +463,7 @@ See Also \ :ref:`ns2.col.foo3 `\ The official documentation on the **ns2.col.foo3** module. \ :ref:`ns2.col.foo `\ lookup plugin - Look up some foo. + Look up some foo \ :ansopt:`ns2.col.foo#module:bar`\ . .. Examples 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 8ed400f9..0148361b 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo shell -- Foo shell -++++++++++++++++++++++++++++++ +ns2.col.foo shell -- Foo shell \ :ansopt:`ns2.col.foo#shell:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -96,6 +96,43 @@ Parameters * - Parameter - Comments + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_shell__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ * - .. raw:: html
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 e2712977..085b587f 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo test -- Is something a foo -++++++++++++++++++++++++++++++++++++++ +ns2.col.foo test -- Is something a foo \ :ansopt:`ns2.col.foo#test:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -135,6 +135,58 @@ This describes the input of the test, the value before ``is ns2.col.foo`` or ``i .. Options +Keyword parameters +------------------ + +This describes keyword parameters of the test. These are the values ``key1=value1``, ``key2=value2`` and so on in the following examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is not ns2.col.foo(key1=value1, key2=value2, ...)``. + +.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_test__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ .. Attributes 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 0df3babc..57fb56d4 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo vars -- Load foo -++++++++++++++++++++++++++++ +ns2.col.foo vars -- Load foo \ :ansopt:`ns2.col.foo#vars:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -159,6 +159,43 @@ Parameters - Environment variable: :envvar:`ANSIBLE\_FOO\_FILENAME\_EXT` + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_vars__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + .. raw:: html
diff --git a/tests/functional/baseline-no-indexes/collections/ns2/col/index.rst b/tests/functional/baseline-no-indexes/collections/ns2/col/index.rst index 4b16b946..57911fb0 100644 --- a/tests/functional/baseline-no-indexes/collections/ns2/col/index.rst +++ b/tests/functional/baseline-no-indexes/collections/ns2/col/index.rst @@ -74,7 +74,7 @@ These are the plugins in the ns2.col collection: Modules ~~~~~~~ -* :ref:`foo module ` -- Do some foo +* :ref:`foo module ` -- Do some foo \ :ansopt:`ns2.col.foo#module:bar`\ * :ref:`foo2 module ` -- Another foo .. toctree:: @@ -88,7 +88,7 @@ Modules Become Plugins ~~~~~~~~~~~~~~ -* :ref:`foo become ` -- Use foo +* :ref:`foo become ` -- Use foo \ :ansopt:`ns2.col.foo#become:bar`\ .. toctree:: :maxdepth: 1 @@ -100,7 +100,7 @@ Become Plugins Cache Plugins ~~~~~~~~~~~~~ -* :ref:`foo cache ` -- Foo files +* :ref:`foo cache ` -- Foo files \ :ansopt:`ns2.col.foo#cache:bar`\ .. toctree:: :maxdepth: 1 @@ -112,7 +112,7 @@ Cache Plugins Callback Plugins ~~~~~~~~~~~~~~~~ -* :ref:`foo callback ` -- Foo output +* :ref:`foo callback ` -- Foo output \ :ansopt:`ns2.col.foo#callback:bar`\ .. toctree:: :maxdepth: 1 @@ -136,7 +136,7 @@ Cliconf Plugins Connection Plugins ~~~~~~~~~~~~~~~~~~ -* :ref:`foo connection ` -- Foo connection +* :ref:`foo connection ` -- Foo connection \ :ansopt:`ns2.col.foo#connection:bar`\ .. toctree:: :maxdepth: 1 @@ -148,7 +148,7 @@ Connection Plugins Filter Plugins ~~~~~~~~~~~~~~ -* :ref:`foo filter ` -- The foo filter +* :ref:`foo filter ` -- The foo filter \ :ansopt:`ns2.col.foo#filter:bar`\ .. toctree:: :maxdepth: 1 @@ -160,7 +160,7 @@ Filter Plugins Inventory Plugins ~~~~~~~~~~~~~~~~~ -* :ref:`foo inventory ` -- The foo inventory +* :ref:`foo inventory ` -- The foo inventory \ :ansopt:`ns2.col.foo#inventory:bar`\ .. toctree:: :maxdepth: 1 @@ -172,7 +172,7 @@ Inventory Plugins Lookup Plugins ~~~~~~~~~~~~~~ -* :ref:`foo lookup ` -- Look up some foo +* :ref:`foo lookup ` -- Look up some foo \ :ansopt:`ns2.col.foo#lookup:bar`\ .. toctree:: :maxdepth: 1 @@ -184,7 +184,7 @@ Lookup Plugins Shell Plugins ~~~~~~~~~~~~~ -* :ref:`foo shell ` -- Foo shell +* :ref:`foo shell ` -- Foo shell \ :ansopt:`ns2.col.foo#shell:bar`\ .. toctree:: :maxdepth: 1 @@ -208,7 +208,7 @@ Strategy Plugins Test Plugins ~~~~~~~~~~~~ -* :ref:`foo test ` -- Is something a foo +* :ref:`foo test ` -- Is something a foo \ :ansopt:`ns2.col.foo#test:bar`\ .. toctree:: :maxdepth: 1 @@ -220,7 +220,7 @@ Test Plugins Vars Plugins ~~~~~~~~~~~~ -* :ref:`foo vars ` -- Load foo +* :ref:`foo vars ` -- Load foo \ :ansopt:`ns2.col.foo#vars:bar`\ .. toctree:: :maxdepth: 1 diff --git a/tests/functional/baseline-squash-hierarchy/foo_become.rst b/tests/functional/baseline-squash-hierarchy/foo_become.rst index 377870ca..a497ffb2 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_become.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_become.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo become -- Use foo -+++++++++++++++++++++++++++++ +ns2.col.foo become -- Use foo \ :ansopt:`ns2.col.foo#become:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note diff --git a/tests/functional/baseline-squash-hierarchy/foo_cache.rst b/tests/functional/baseline-squash-hierarchy/foo_cache.rst index 219ae0f6..a8d6c718 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_cache.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_cache.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo cache -- Foo files -++++++++++++++++++++++++++++++ +ns2.col.foo cache -- Foo files \ :ansopt:`ns2.col.foo#cache:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -144,6 +144,43 @@ Parameters - Environment variable: :envvar:`ANSIBLE\_CACHE\_PLUGIN\_CONNECTION` + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_cache__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Nothing. + + .. raw:: html
diff --git a/tests/functional/baseline-squash-hierarchy/foo_callback.rst b/tests/functional/baseline-squash-hierarchy/foo_callback.rst index 0a05f01f..f164ab6b 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_callback.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_callback.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo callback -- Foo output -++++++++++++++++++++++++++++++++++ +ns2.col.foo callback -- Foo output \ :ansopt:`ns2.col.foo#callback:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -88,6 +88,57 @@ Synopsis .. Options +Parameters +---------- + + +.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_callback__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Nothing. + + + .. raw:: html + +
+ .. Attributes diff --git a/tests/functional/baseline-squash-hierarchy/foo_connection.rst b/tests/functional/baseline-squash-hierarchy/foo_connection.rst index d86619d4..fe063648 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_connection.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_connection.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo connection -- Foo connection -++++++++++++++++++++++++++++++++++++++++ +ns2.col.foo connection -- Foo connection \ :ansopt:`ns2.col.foo#connection:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -96,6 +96,43 @@ Parameters * - Parameter - Comments + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_connection__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`integer` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/tests/functional/baseline-squash-hierarchy/foo_filter.rst b/tests/functional/baseline-squash-hierarchy/foo_filter.rst index fe22438a..cae67ce3 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_filter.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_filter.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo filter -- The foo filter -++++++++++++++++++++++++++++++++++++ +ns2.col.foo filter -- The foo filter \ :ansopt:`ns2.col.foo#filter:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -153,6 +153,43 @@ This describes keyword parameters of the filter. These are the values ``key1=val * - Parameter - Comments + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_filter__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Some bar. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/tests/functional/baseline-squash-hierarchy/foo_inventory.rst b/tests/functional/baseline-squash-hierarchy/foo_inventory.rst index 05b86c02..50aeb71f 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_inventory.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_inventory.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo inventory -- The foo inventory -++++++++++++++++++++++++++++++++++++++++++ +ns2.col.foo inventory -- The foo inventory \ :ansopt:`ns2.col.foo#inventory:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -82,6 +82,57 @@ Synopsis .. Options +Parameters +---------- + + +.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_inventory__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ .. Attributes diff --git a/tests/functional/baseline-squash-hierarchy/foo_lookup.rst b/tests/functional/baseline-squash-hierarchy/foo_lookup.rst index a48b569b..308a2d7f 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_lookup.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_lookup.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo lookup -- Look up some foo -++++++++++++++++++++++++++++++++++++++ +ns2.col.foo lookup -- Look up some foo \ :ansopt:`ns2.col.foo#lookup:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -137,6 +137,57 @@ Terms .. Options +Parameters +---------- + + +.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_lookup__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ .. Attributes diff --git a/tests/functional/baseline-squash-hierarchy/foo_module.rst b/tests/functional/baseline-squash-hierarchy/foo_module.rst index 20f89a55..27ec6c5a 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_module.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_module.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo module -- Do some foo -+++++++++++++++++++++++++++++++++ +ns2.col.foo module -- Do some foo \ :ansopt:`ns2.col.foo#module:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -463,7 +463,7 @@ See Also \ :ref:`ns2.col.foo3 `\ The official documentation on the **ns2.col.foo3** module. \ :ref:`ns2.col.foo `\ lookup plugin - Look up some foo. + Look up some foo \ :ansopt:`ns2.col.foo#module:bar`\ . .. Examples diff --git a/tests/functional/baseline-squash-hierarchy/foo_shell.rst b/tests/functional/baseline-squash-hierarchy/foo_shell.rst index 8ed400f9..0148361b 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_shell.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_shell.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo shell -- Foo shell -++++++++++++++++++++++++++++++ +ns2.col.foo shell -- Foo shell \ :ansopt:`ns2.col.foo#shell:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -96,6 +96,43 @@ Parameters * - Parameter - Comments + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_shell__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/tests/functional/baseline-squash-hierarchy/foo_test.rst b/tests/functional/baseline-squash-hierarchy/foo_test.rst index e2712977..085b587f 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_test.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_test.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo test -- Is something a foo -++++++++++++++++++++++++++++++++++++++ +ns2.col.foo test -- Is something a foo \ :ansopt:`ns2.col.foo#test:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -135,6 +135,58 @@ This describes the input of the test, the value before ``is ns2.col.foo`` or ``i .. Options +Keyword parameters +------------------ + +This describes keyword parameters of the test. These are the values ``key1=value1``, ``key2=value2`` and so on in the following examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is not ns2.col.foo(key1=value1, key2=value2, ...)``. + +.. rst-class:: ansible-option-table + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_test__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + + .. raw:: html + +
+ .. Attributes diff --git a/tests/functional/baseline-squash-hierarchy/foo_vars.rst b/tests/functional/baseline-squash-hierarchy/foo_vars.rst index 0df3babc..57fb56d4 100644 --- a/tests/functional/baseline-squash-hierarchy/foo_vars.rst +++ b/tests/functional/baseline-squash-hierarchy/foo_vars.rst @@ -37,8 +37,8 @@ .. Title -ns2.col.foo vars -- Load foo -++++++++++++++++++++++++++++ +ns2.col.foo vars -- Load foo \ :ansopt:`ns2.col.foo#vars:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -159,6 +159,43 @@ Parameters - Environment variable: :envvar:`ANSIBLE\_FOO\_FILENAME\_EXT` + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.ns2.col.foo_vars__parameter-bar: + + .. rst-class:: ansible-option-title + + **bar** + + .. raw:: html + + + + .. rst-class:: ansible-option-type-line + + :ansible-option-type:`string` + + + + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Foo bar. + + .. raw:: html
diff --git a/tests/functional/baseline-squash-hierarchy/index.rst b/tests/functional/baseline-squash-hierarchy/index.rst index 8dbec2a9..1d4545a4 100644 --- a/tests/functional/baseline-squash-hierarchy/index.rst +++ b/tests/functional/baseline-squash-hierarchy/index.rst @@ -74,7 +74,7 @@ These are the plugins in the ns2.col collection: Modules ~~~~~~~ -* :ref:`foo module ` -- Do some foo +* :ref:`foo module ` -- Do some foo \ :ansopt:`ns2.col.foo#module:bar`\ * :ref:`foo2 module ` -- Another foo .. toctree:: @@ -88,7 +88,7 @@ Modules Become Plugins ~~~~~~~~~~~~~~ -* :ref:`foo become ` -- Use foo +* :ref:`foo become ` -- Use foo \ :ansopt:`ns2.col.foo#become:bar`\ .. toctree:: :maxdepth: 1 @@ -100,7 +100,7 @@ Become Plugins Cache Plugins ~~~~~~~~~~~~~ -* :ref:`foo cache ` -- Foo files +* :ref:`foo cache ` -- Foo files \ :ansopt:`ns2.col.foo#cache:bar`\ .. toctree:: :maxdepth: 1 @@ -112,7 +112,7 @@ Cache Plugins Callback Plugins ~~~~~~~~~~~~~~~~ -* :ref:`foo callback ` -- Foo output +* :ref:`foo callback ` -- Foo output \ :ansopt:`ns2.col.foo#callback:bar`\ .. toctree:: :maxdepth: 1 @@ -136,7 +136,7 @@ Cliconf Plugins Connection Plugins ~~~~~~~~~~~~~~~~~~ -* :ref:`foo connection ` -- Foo connection +* :ref:`foo connection ` -- Foo connection \ :ansopt:`ns2.col.foo#connection:bar`\ .. toctree:: :maxdepth: 1 @@ -148,7 +148,7 @@ Connection Plugins Filter Plugins ~~~~~~~~~~~~~~ -* :ref:`foo filter ` -- The foo filter +* :ref:`foo filter ` -- The foo filter \ :ansopt:`ns2.col.foo#filter:bar`\ .. toctree:: :maxdepth: 1 @@ -160,7 +160,7 @@ Filter Plugins Inventory Plugins ~~~~~~~~~~~~~~~~~ -* :ref:`foo inventory ` -- The foo inventory +* :ref:`foo inventory ` -- The foo inventory \ :ansopt:`ns2.col.foo#inventory:bar`\ .. toctree:: :maxdepth: 1 @@ -172,7 +172,7 @@ Inventory Plugins Lookup Plugins ~~~~~~~~~~~~~~ -* :ref:`foo lookup ` -- Look up some foo +* :ref:`foo lookup ` -- Look up some foo \ :ansopt:`ns2.col.foo#lookup:bar`\ .. toctree:: :maxdepth: 1 @@ -184,7 +184,7 @@ Lookup Plugins Shell Plugins ~~~~~~~~~~~~~ -* :ref:`foo shell ` -- Foo shell +* :ref:`foo shell ` -- Foo shell \ :ansopt:`ns2.col.foo#shell:bar`\ .. toctree:: :maxdepth: 1 @@ -208,7 +208,7 @@ Strategy Plugins Test Plugins ~~~~~~~~~~~~ -* :ref:`foo test ` -- Is something a foo +* :ref:`foo test ` -- Is something a foo \ :ansopt:`ns2.col.foo#test:bar`\ .. toctree:: :maxdepth: 1 @@ -220,7 +220,7 @@ Test Plugins Vars Plugins ~~~~~~~~~~~~ -* :ref:`foo vars ` -- Load foo +* :ref:`foo vars ` -- Load foo \ :ansopt:`ns2.col.foo#vars:bar`\ .. toctree:: :maxdepth: 1 diff --git a/tests/functional/baseline-use-html-blobs/collections/callback_index_stdout.rst b/tests/functional/baseline-use-html-blobs/collections/callback_index_stdout.rst index bf8507ee..eb1be590 100644 --- a/tests/functional/baseline-use-html-blobs/collections/callback_index_stdout.rst +++ b/tests/functional/baseline-use-html-blobs/collections/callback_index_stdout.rst @@ -11,5 +11,5 @@ See :ref:`list_of_callback_plugins` for the list of *all* callback plugins. ns2.col ------- -* :ref:`ns2.col.foo ` -- Foo output +* :ref:`ns2.col.foo ` -- Foo output \ :ansopt:`ns2.col.foo#callback:bar`\ diff --git a/tests/functional/baseline-use-html-blobs/collections/index_become.rst b/tests/functional/baseline-use-html-blobs/collections/index_become.rst index 2164fbe4..22320c90 100644 --- a/tests/functional/baseline-use-html-blobs/collections/index_become.rst +++ b/tests/functional/baseline-use-html-blobs/collections/index_become.rst @@ -9,5 +9,5 @@ Index of all Become Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Use foo +* :ref:`ns2.col.foo ` -- Use foo \ :ansopt:`ns2.col.foo#become:bar`\ diff --git a/tests/functional/baseline-use-html-blobs/collections/index_cache.rst b/tests/functional/baseline-use-html-blobs/collections/index_cache.rst index 66467af5..7a9d56a0 100644 --- a/tests/functional/baseline-use-html-blobs/collections/index_cache.rst +++ b/tests/functional/baseline-use-html-blobs/collections/index_cache.rst @@ -9,5 +9,5 @@ Index of all Cache Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Foo files +* :ref:`ns2.col.foo ` -- Foo files \ :ansopt:`ns2.col.foo#cache:bar`\ diff --git a/tests/functional/baseline-use-html-blobs/collections/index_callback.rst b/tests/functional/baseline-use-html-blobs/collections/index_callback.rst index c982c8ae..0c297f89 100644 --- a/tests/functional/baseline-use-html-blobs/collections/index_callback.rst +++ b/tests/functional/baseline-use-html-blobs/collections/index_callback.rst @@ -17,5 +17,5 @@ Index of all Callback Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Foo output +* :ref:`ns2.col.foo ` -- Foo output \ :ansopt:`ns2.col.foo#callback:bar`\ diff --git a/tests/functional/baseline-use-html-blobs/collections/index_connection.rst b/tests/functional/baseline-use-html-blobs/collections/index_connection.rst index 7100cdd4..2d2fe2e1 100644 --- a/tests/functional/baseline-use-html-blobs/collections/index_connection.rst +++ b/tests/functional/baseline-use-html-blobs/collections/index_connection.rst @@ -9,5 +9,5 @@ Index of all Connection Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Foo connection +* :ref:`ns2.col.foo ` -- Foo connection \ :ansopt:`ns2.col.foo#connection:bar`\ diff --git a/tests/functional/baseline-use-html-blobs/collections/index_filter.rst b/tests/functional/baseline-use-html-blobs/collections/index_filter.rst index be6417ab..e8733ee6 100644 --- a/tests/functional/baseline-use-html-blobs/collections/index_filter.rst +++ b/tests/functional/baseline-use-html-blobs/collections/index_filter.rst @@ -9,5 +9,5 @@ Index of all Filter Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- The foo filter +* :ref:`ns2.col.foo ` -- The foo filter \ :ansopt:`ns2.col.foo#filter:bar`\ diff --git a/tests/functional/baseline-use-html-blobs/collections/index_inventory.rst b/tests/functional/baseline-use-html-blobs/collections/index_inventory.rst index 792627ef..82638b0e 100644 --- a/tests/functional/baseline-use-html-blobs/collections/index_inventory.rst +++ b/tests/functional/baseline-use-html-blobs/collections/index_inventory.rst @@ -9,5 +9,5 @@ Index of all Inventory Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- The foo inventory +* :ref:`ns2.col.foo ` -- The foo inventory \ :ansopt:`ns2.col.foo#inventory:bar`\ diff --git a/tests/functional/baseline-use-html-blobs/collections/index_lookup.rst b/tests/functional/baseline-use-html-blobs/collections/index_lookup.rst index 2550951c..0643d7a6 100644 --- a/tests/functional/baseline-use-html-blobs/collections/index_lookup.rst +++ b/tests/functional/baseline-use-html-blobs/collections/index_lookup.rst @@ -9,5 +9,5 @@ Index of all Lookup Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Look up some foo +* :ref:`ns2.col.foo ` -- Look up some foo \ :ansopt:`ns2.col.foo#lookup:bar`\ diff --git a/tests/functional/baseline-use-html-blobs/collections/index_module.rst b/tests/functional/baseline-use-html-blobs/collections/index_module.rst index 1cfca20d..5f4d3b1f 100644 --- a/tests/functional/baseline-use-html-blobs/collections/index_module.rst +++ b/tests/functional/baseline-use-html-blobs/collections/index_module.rst @@ -9,6 +9,6 @@ Index of all Modules ns2.col ------- -* :ref:`ns2.col.foo ` -- Do some foo +* :ref:`ns2.col.foo ` -- Do some foo \ :ansopt:`ns2.col.foo#module:bar`\ * :ref:`ns2.col.foo2 ` -- Another foo diff --git a/tests/functional/baseline-use-html-blobs/collections/index_shell.rst b/tests/functional/baseline-use-html-blobs/collections/index_shell.rst index 4f3cc8a7..4199a913 100644 --- a/tests/functional/baseline-use-html-blobs/collections/index_shell.rst +++ b/tests/functional/baseline-use-html-blobs/collections/index_shell.rst @@ -9,5 +9,5 @@ Index of all Shell Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Foo shell +* :ref:`ns2.col.foo ` -- Foo shell \ :ansopt:`ns2.col.foo#shell:bar`\ diff --git a/tests/functional/baseline-use-html-blobs/collections/index_test.rst b/tests/functional/baseline-use-html-blobs/collections/index_test.rst index 876cd1f4..775fd6e8 100644 --- a/tests/functional/baseline-use-html-blobs/collections/index_test.rst +++ b/tests/functional/baseline-use-html-blobs/collections/index_test.rst @@ -9,5 +9,5 @@ Index of all Test Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Is something a foo +* :ref:`ns2.col.foo ` -- Is something a foo \ :ansopt:`ns2.col.foo#test:bar`\ diff --git a/tests/functional/baseline-use-html-blobs/collections/index_vars.rst b/tests/functional/baseline-use-html-blobs/collections/index_vars.rst index 16ea4aba..112eaaac 100644 --- a/tests/functional/baseline-use-html-blobs/collections/index_vars.rst +++ b/tests/functional/baseline-use-html-blobs/collections/index_vars.rst @@ -9,5 +9,5 @@ Index of all Vars Plugins ns2.col ------- -* :ref:`ns2.col.foo ` -- Load foo +* :ref:`ns2.col.foo ` -- Load foo \ :ansopt:`ns2.col.foo#vars:bar`\ 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 1fac1d72..147d8b02 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo become -- Use foo -+++++++++++++++++++++++++++++ +ns2.col.foo become -- Use foo \ :ansopt:`ns2.col.foo#become:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note 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 14d28d6b..6c855cd4 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo cache -- Foo files -++++++++++++++++++++++++++++++ +ns2.col.foo cache -- Foo files \ :ansopt:`ns2.col.foo#cache:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -124,6 +124,20 @@ Parameters
+ +
+
+

bar

+ +

+ string +

+ +
+
+

Nothing.

+
+ 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 0a05f01f..4b006578 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo callback -- Foo output -++++++++++++++++++++++++++++++++++ +ns2.col.foo callback -- Foo output \ :ansopt:`ns2.col.foo#callback:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -88,6 +88,38 @@ Synopsis .. Options +Parameters +---------- + + +.. raw:: html + + + + + + + + + + + + + + +

Parameter

Comments

+
+

bar

+ +

+ string +

+ +
+

Nothing.

+
+ + .. Attributes 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 cc159516..13ef32b1 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo connection -- Foo connection -++++++++++++++++++++++++++++++++++++++++ +ns2.col.foo connection -- Foo connection \ :ansopt:`ns2.col.foo#connection:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -97,6 +97,20 @@ Parameters +
+
+

bar

+ +

+ integer +

+ +
+
+

Foo bar.

+
+ +

host

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 cfd028eb..69c94ae9 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo filter -- The foo filter -++++++++++++++++++++++++++++++++++++ +ns2.col.foo filter -- The foo filter \ :ansopt:`ns2.col.foo#filter:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -136,6 +136,20 @@ This describes keyword parameters of the filter. These are the values ``key1=val +
+
+

bar

+ +

+ string +

+ +
+
+

Some bar.

+
+ +

foo

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 05b86c02..634e2fe2 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo inventory -- The foo inventory -++++++++++++++++++++++++++++++++++++++++++ +ns2.col.foo inventory -- The foo inventory \ :ansopt:`ns2.col.foo#inventory:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -82,6 +82,38 @@ Synopsis .. Options +Parameters +---------- + + +.. raw:: html + + + + + + + + + + + + + + +

Parameter

Comments

+
+

bar

+ +

+ string +

+ +
+

Foo bar.

+
+ + .. Attributes 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 bac0c247..ea50555a 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo lookup -- Look up some foo -++++++++++++++++++++++++++++++++++++++ +ns2.col.foo lookup -- Look up some foo \ :ansopt:`ns2.col.foo#lookup:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -120,6 +120,38 @@ Terms .. Options +Parameters +---------- + + +.. raw:: html + + + + + + + + + + + + + + +

Parameter

Comments

+
+

bar

+ +

+ string +

+ +
+

Foo bar.

+
+ + .. Attributes 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 325478b2..1df6a14b 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo module -- Do some foo -+++++++++++++++++++++++++++++++++ +ns2.col.foo module -- Do some foo \ :ansopt:`ns2.col.foo#module:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -376,7 +376,7 @@ See Also \ :ref:`ns2.col.foo3 `\ The official documentation on the **ns2.col.foo3** module. \ :ref:`ns2.col.foo `\ lookup plugin - Look up some foo. + Look up some foo \ :ansopt:`ns2.col.foo#module:bar`\ . .. Examples 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 e582806e..f5ba1b22 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo shell -- Foo shell -++++++++++++++++++++++++++++++ +ns2.col.foo shell -- Foo shell \ :ansopt:`ns2.col.foo#shell:bar`\ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -97,6 +97,20 @@ Parameters +
+
+

bar

+ +

+ string +

+ +
+
+

Foo bar.

+
+ +

remote_tmp

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 24a79c31..2acd0e5e 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo test -- Is something a foo -++++++++++++++++++++++++++++++++++++++ +ns2.col.foo test -- Is something a foo \ :ansopt:`ns2.col.foo#test:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -117,6 +117,39 @@ This describes the input of the test, the value before ``is ns2.col.foo`` or ``i .. Options +Keyword parameters +------------------ + +This describes keyword parameters of the test. These are the values ``key1=value1``, ``key2=value2`` and so on in the following examples: ``input is ns2.col.foo(key1=value1, key2=value2, ...)`` and ``input is not ns2.col.foo(key1=value1, key2=value2, ...)``. + +.. raw:: html + + + + + + + + + + + + + + +

Parameter

Comments

+
+

bar

+ +

+ string +

+ +
+

Foo bar.

+
+ + .. Attributes 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 080ce90c..0982b5de 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 @@ -37,8 +37,8 @@ .. Title -ns2.col.foo vars -- Load foo -++++++++++++++++++++++++++++ +ns2.col.foo vars -- Load foo \ :ansopt:`ns2.col.foo#vars:bar`\ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note @@ -136,6 +136,20 @@ Parameters
+ +
+
+

bar

+ +

+ string +

+ +
+
+

Foo bar.

+
+ diff --git a/tests/functional/baseline-use-html-blobs/collections/ns2/col/index.rst b/tests/functional/baseline-use-html-blobs/collections/ns2/col/index.rst index 4b16b946..57911fb0 100644 --- a/tests/functional/baseline-use-html-blobs/collections/ns2/col/index.rst +++ b/tests/functional/baseline-use-html-blobs/collections/ns2/col/index.rst @@ -74,7 +74,7 @@ These are the plugins in the ns2.col collection: Modules ~~~~~~~ -* :ref:`foo module ` -- Do some foo +* :ref:`foo module ` -- Do some foo \ :ansopt:`ns2.col.foo#module:bar`\ * :ref:`foo2 module ` -- Another foo .. toctree:: @@ -88,7 +88,7 @@ Modules Become Plugins ~~~~~~~~~~~~~~ -* :ref:`foo become ` -- Use foo +* :ref:`foo become ` -- Use foo \ :ansopt:`ns2.col.foo#become:bar`\ .. toctree:: :maxdepth: 1 @@ -100,7 +100,7 @@ Become Plugins Cache Plugins ~~~~~~~~~~~~~ -* :ref:`foo cache ` -- Foo files +* :ref:`foo cache ` -- Foo files \ :ansopt:`ns2.col.foo#cache:bar`\ .. toctree:: :maxdepth: 1 @@ -112,7 +112,7 @@ Cache Plugins Callback Plugins ~~~~~~~~~~~~~~~~ -* :ref:`foo callback ` -- Foo output +* :ref:`foo callback ` -- Foo output \ :ansopt:`ns2.col.foo#callback:bar`\ .. toctree:: :maxdepth: 1 @@ -136,7 +136,7 @@ Cliconf Plugins Connection Plugins ~~~~~~~~~~~~~~~~~~ -* :ref:`foo connection ` -- Foo connection +* :ref:`foo connection ` -- Foo connection \ :ansopt:`ns2.col.foo#connection:bar`\ .. toctree:: :maxdepth: 1 @@ -148,7 +148,7 @@ Connection Plugins Filter Plugins ~~~~~~~~~~~~~~ -* :ref:`foo filter ` -- The foo filter +* :ref:`foo filter ` -- The foo filter \ :ansopt:`ns2.col.foo#filter:bar`\ .. toctree:: :maxdepth: 1 @@ -160,7 +160,7 @@ Filter Plugins Inventory Plugins ~~~~~~~~~~~~~~~~~ -* :ref:`foo inventory ` -- The foo inventory +* :ref:`foo inventory ` -- The foo inventory \ :ansopt:`ns2.col.foo#inventory:bar`\ .. toctree:: :maxdepth: 1 @@ -172,7 +172,7 @@ Inventory Plugins Lookup Plugins ~~~~~~~~~~~~~~ -* :ref:`foo lookup ` -- Look up some foo +* :ref:`foo lookup ` -- Look up some foo \ :ansopt:`ns2.col.foo#lookup:bar`\ .. toctree:: :maxdepth: 1 @@ -184,7 +184,7 @@ Lookup Plugins Shell Plugins ~~~~~~~~~~~~~ -* :ref:`foo shell ` -- Foo shell +* :ref:`foo shell ` -- Foo shell \ :ansopt:`ns2.col.foo#shell:bar`\ .. toctree:: :maxdepth: 1 @@ -208,7 +208,7 @@ Strategy Plugins Test Plugins ~~~~~~~~~~~~ -* :ref:`foo test ` -- Is something a foo +* :ref:`foo test ` -- Is something a foo \ :ansopt:`ns2.col.foo#test:bar`\ .. toctree:: :maxdepth: 1 @@ -220,7 +220,7 @@ Test Plugins Vars Plugins ~~~~~~~~~~~~ -* :ref:`foo vars ` -- Load foo +* :ref:`foo vars ` -- Load foo \ :ansopt:`ns2.col.foo#vars:bar`\ .. toctree:: :maxdepth: 1 diff --git a/tests/functional/collections/ansible_collections/ns2/col/plugins/become/foo.py b/tests/functional/collections/ansible_collections/ns2/col/plugins/become/foo.py index 44a0c2b3..b8140194 100644 --- a/tests/functional/collections/ansible_collections/ns2/col/plugins/become/foo.py +++ b/tests/functional/collections/ansible_collections/ns2/col/plugins/become/foo.py @@ -8,7 +8,7 @@ DOCUMENTATION = """ name: foo - short_description: Use foo + short_description: Use foo O(bar) description: - This become plugin uses foo. - This is a second paragraph. diff --git a/tests/functional/collections/ansible_collections/ns2/col/plugins/cache/foo.py b/tests/functional/collections/ansible_collections/ns2/col/plugins/cache/foo.py index 6ffedf7f..bdee54b3 100644 --- a/tests/functional/collections/ansible_collections/ns2/col/plugins/cache/foo.py +++ b/tests/functional/collections/ansible_collections/ns2/col/plugins/cache/foo.py @@ -8,7 +8,7 @@ DOCUMENTATION = ''' name: foo - short_description: Foo files + short_description: Foo files O(bar) description: - Cache foo files. version_added: "1.9.0" @@ -24,6 +24,9 @@ - key: fact_caching_connection section: defaults type: path + bar: + description: Nothing. + type: str ''' from ansible.plugins.cache import BaseFileCacheModule diff --git a/tests/functional/collections/ansible_collections/ns2/col/plugins/callback/foo.py b/tests/functional/collections/ansible_collections/ns2/col/plugins/callback/foo.py index ccddc3e9..a45dbefb 100644 --- a/tests/functional/collections/ansible_collections/ns2/col/plugins/callback/foo.py +++ b/tests/functional/collections/ansible_collections/ns2/col/plugins/callback/foo.py @@ -9,10 +9,14 @@ DOCUMENTATION = ''' name: foo type: stdout - short_description: Foo output + short_description: Foo output O(bar) version_added: 0.0.1 description: - Absolut minimal foo output. + options: + bar: + description: Nothing. + type: string ''' from ansible.plugins.callback import CallbackBase diff --git a/tests/functional/collections/ansible_collections/ns2/col/plugins/connection/foo.py b/tests/functional/collections/ansible_collections/ns2/col/plugins/connection/foo.py index d75d2c5c..5749a856 100644 --- a/tests/functional/collections/ansible_collections/ns2/col/plugins/connection/foo.py +++ b/tests/functional/collections/ansible_collections/ns2/col/plugins/connection/foo.py @@ -8,7 +8,7 @@ DOCUMENTATION = ''' name: foo - short_description: Foo connection + short_description: Foo connection O(bar) version_added: 1.2.0 description: - This is for the C(foo) connection. @@ -26,6 +26,9 @@ - name: ansible_ssh_host - name: delegated_vars['ansible_host'] - name: delegated_vars['ansible_ssh_host'] + bar: + description: Foo bar. + type: int ''' from ansible.plugins.connection import ConnectionBase diff --git a/tests/functional/collections/ansible_collections/ns2/col/plugins/filter/foo.py b/tests/functional/collections/ansible_collections/ns2/col/plugins/filter/foo.py index eaab63f7..7edfa602 100644 --- a/tests/functional/collections/ansible_collections/ns2/col/plugins/filter/foo.py +++ b/tests/functional/collections/ansible_collections/ns2/col/plugins/filter/foo.py @@ -10,7 +10,7 @@ DOCUMENTATION = r''' name: foo version_added: 1.3.0 - short_description: The foo filter + short_description: The foo filter O(bar) description: - Do some fooing. options: @@ -23,6 +23,9 @@ type: list elements: dictionary required: true + bar: + description: Some bar. + type: string ''' EXAMPLES = r''' diff --git a/tests/functional/collections/ansible_collections/ns2/col/plugins/inventory/foo.py b/tests/functional/collections/ansible_collections/ns2/col/plugins/inventory/foo.py index a364790a..07e13b2b 100644 --- a/tests/functional/collections/ansible_collections/ns2/col/plugins/inventory/foo.py +++ b/tests/functional/collections/ansible_collections/ns2/col/plugins/inventory/foo.py @@ -9,9 +9,13 @@ DOCUMENTATION = ''' name: foo version_added: 0.5.0 - short_description: The foo inventory + short_description: The foo inventory O(bar) description: - Loads inventory from foo. + options: + bar: + description: Foo bar. + type: string ''' EXAMPLES = ''' diff --git a/tests/functional/collections/ansible_collections/ns2/col/plugins/lookup/foo.py b/tests/functional/collections/ansible_collections/ns2/col/plugins/lookup/foo.py index 0f080284..dcee7628 100644 --- a/tests/functional/collections/ansible_collections/ns2/col/plugins/lookup/foo.py +++ b/tests/functional/collections/ansible_collections/ns2/col/plugins/lookup/foo.py @@ -10,7 +10,7 @@ name: foo author: Felix Fontein (@felixfontein) version_added: "1.0.0" - short_description: Look up some foo + short_description: Look up some foo O(bar) description: - This looks up some foo. - Whatever that is. @@ -20,6 +20,9 @@ required: true type: list elements: str + bar: + description: Foo bar. + type: string """ EXAMPLES = """ diff --git a/tests/functional/collections/ansible_collections/ns2/col/plugins/modules/foo.py b/tests/functional/collections/ansible_collections/ns2/col/plugins/modules/foo.py index 210fa0a4..6e367124 100644 --- a/tests/functional/collections/ansible_collections/ns2/col/plugins/modules/foo.py +++ b/tests/functional/collections/ansible_collections/ns2/col/plugins/modules/foo.py @@ -15,7 +15,7 @@ - "Ansible Core Team" - "Someone else (@ansible)" version_added: "2.0.0" -short_description: Do some foo +short_description: Do some foo O(bar) description: - Does some foo on the remote host. - Whether foo is magic or not has not yet been determined. diff --git a/tests/functional/collections/ansible_collections/ns2/col/plugins/shell/foo.py b/tests/functional/collections/ansible_collections/ns2/col/plugins/shell/foo.py index 43ee7846..087f9266 100644 --- a/tests/functional/collections/ansible_collections/ns2/col/plugins/shell/foo.py +++ b/tests/functional/collections/ansible_collections/ns2/col/plugins/shell/foo.py @@ -8,7 +8,7 @@ DOCUMENTATION = ''' name: foo -short_description: Foo shell +short_description: Foo shell O(bar) version_added: 1.0.0 description: - This is for the foo shell. @@ -27,6 +27,9 @@ - name: ansible_remote_tmp version_added: '2.10' version_added_collection: ansible.builtin + bar: + description: Foo bar. + type: string ''' from ansible.plugins.shell import ShellBase diff --git a/tests/functional/collections/ansible_collections/ns2/col/plugins/test/foo.py b/tests/functional/collections/ansible_collections/ns2/col/plugins/test/foo.py index 45343949..7ae970b0 100644 --- a/tests/functional/collections/ansible_collections/ns2/col/plugins/test/foo.py +++ b/tests/functional/collections/ansible_collections/ns2/col/plugins/test/foo.py @@ -10,7 +10,7 @@ DOCUMENTATION = r''' name: foo author: Nobody - short_description: Is something a foo + short_description: Is something a foo O(bar) description: - Check whether the input dictionary is a foo. options: @@ -18,6 +18,9 @@ description: Something to test. type: dictionary required: true + bar: + description: Foo bar. + type: string ''' EXAMPLES = r''' diff --git a/tests/functional/collections/ansible_collections/ns2/col/plugins/vars/foo.py b/tests/functional/collections/ansible_collections/ns2/col/plugins/vars/foo.py index d4f9f337..0ef11f81 100644 --- a/tests/functional/collections/ansible_collections/ns2/col/plugins/vars/foo.py +++ b/tests/functional/collections/ansible_collections/ns2/col/plugins/vars/foo.py @@ -9,7 +9,7 @@ DOCUMENTATION = ''' name: foo version_added: 0.9.0 - short_description: Load foo + short_description: Load foo O(bar) requirements: - Enabled in Ansible's configuration. description: @@ -29,6 +29,9 @@ section: defaults type: list elements: string + bar: + description: Foo bar. + type: string ''' from ansible.plugins.vars import BaseVarsPlugin