-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d0aba6f
commit 3d4f8e9
Showing
7 changed files
with
1,275 additions
and
0 deletions.
There are no files selected for viewing
253 changes: 253 additions & 0 deletions
253
tests/functional/baseline-default/collections/ns2/col/bar_lookup.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,253 @@ | ||
|
||
.. Document meta | ||
:orphan: | ||
:github_url: https://github.com/ansible-community/antsibull-docs/edit/main/tests/functional/collections/ansible_collections/ns2/col/plugins/lookup/bar.py?description=%23%23%23%23%23%20SUMMARY%0A%3C!---%20Your%20description%20here%20--%3E%0A%0A%0A%23%23%23%23%23%20ISSUE%20TYPE%0A-%20Docs%20Pull%20Request%0A%0A%2Blabel:%20docsite_pr | ||
|
||
.. |antsibull-internal-nbsp| unicode:: 0xA0 | ||
:trim: | ||
|
||
.. role:: ansible-attribute-support-label | ||
.. role:: ansible-attribute-support-property | ||
.. role:: ansible-attribute-support-full | ||
.. role:: ansible-attribute-support-partial | ||
.. role:: ansible-attribute-support-none | ||
.. role:: ansible-attribute-support-na | ||
.. role:: ansible-option-type | ||
.. role:: ansible-option-elements | ||
.. role:: ansible-option-required | ||
.. role:: ansible-option-versionadded | ||
.. role:: ansible-option-aliases | ||
.. role:: ansible-option-choices | ||
.. role:: ansible-option-choices-default-mark | ||
.. role:: ansible-option-default-bold | ||
.. role:: ansible-option-configuration | ||
.. role:: ansible-option-returned-bold | ||
.. role:: ansible-option-sample-bold | ||
|
||
.. Anchors | ||
.. _ansible_collections.ns2.col.bar_lookup: | ||
|
||
.. Anchors: short name for ansible.builtin | ||
.. Anchors: aliases | ||
.. Title | ||
ns2.col.bar lookup -- Look up some bar | ||
++++++++++++++++++++++++++++++++++++++ | ||
|
||
.. Collection note | ||
.. note:: | ||
This lookup plugin is part of the `ns2.col collection <https://galaxy.ansible.com/ns2/col>`_ (version 2.1.0). | ||
|
||
To install it, use: :code:`ansible-galaxy collection install ns2.col`. | ||
|
||
To use it in a playbook, specify: :code:`ns2.col.bar`. | ||
|
||
.. version_added | ||
.. rst-class:: ansible-version-added | ||
|
||
New in ns2.col 1.0.0 | ||
|
||
.. contents:: | ||
:local: | ||
:depth: 1 | ||
|
||
.. Deprecated | ||
Synopsis | ||
-------- | ||
|
||
.. Description | ||
- This one is private. | ||
|
||
|
||
.. Aliases | ||
.. Requirements | ||
.. Terms | ||
Terms | ||
----- | ||
|
||
.. rst-class:: ansible-option-table | ||
|
||
.. list-table:: | ||
:width: 100% | ||
:widths: auto | ||
:header-rows: 1 | ||
|
||
* - Parameter | ||
- Comments | ||
|
||
* - .. raw:: html | ||
|
||
<div class="ansible-option-cell"> | ||
<div class="ansibleOptionAnchor" id="parameter-_terms"></div> | ||
|
||
.. _ansible_collections.ns2.col.bar_lookup__parameter-_terms: | ||
|
||
.. rst-class:: ansible-option-title | ||
|
||
**Terms** | ||
|
||
.. raw:: html | ||
|
||
<a class="ansibleOptionLink" href="#parameter-_terms" title="Permalink to this option"></a> | ||
|
||
.. rst-class:: ansible-option-type-line | ||
|
||
:ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` / :ansible-option-required:`required` | ||
|
||
|
||
|
||
|
||
.. raw:: html | ||
|
||
</div> | ||
|
||
- .. raw:: html | ||
|
||
<div class="ansible-option-cell"> | ||
|
||
Something | ||
|
||
|
||
.. raw:: html | ||
|
||
</div> | ||
|
||
|
||
|
||
|
||
|
||
.. Options | ||
.. Attributes | ||
.. Notes | ||
.. Seealso | ||
.. Examples | ||
Examples | ||
-------- | ||
|
||
.. code-block:: yaml+jinja | ||
|
||
|
||
- name: Look up! | ||
ansible.builtin.debug: | ||
msg: "{{ lookup('ns2.col.bar', {}) }}" | ||
|
||
|
||
|
||
|
||
.. Facts | ||
.. Return values | ||
Return Value | ||
------------ | ||
|
||
.. rst-class:: ansible-option-table | ||
|
||
.. list-table:: | ||
:width: 100% | ||
:widths: auto | ||
:header-rows: 1 | ||
|
||
* - Key | ||
- Description | ||
|
||
* - .. raw:: html | ||
|
||
<div class="ansible-option-cell"> | ||
<div class="ansibleOptionAnchor" id="return-_raw"></div> | ||
|
||
.. _ansible_collections.ns2.col.bar_lookup__return-_raw: | ||
|
||
.. rst-class:: ansible-option-title | ||
|
||
**Return value** | ||
|
||
.. raw:: html | ||
|
||
<a class="ansibleOptionLink" href="#return-_raw" title="Permalink to this return value"></a> | ||
|
||
.. rst-class:: ansible-option-type-line | ||
|
||
:ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` | ||
|
||
.. raw:: html | ||
|
||
</div> | ||
|
||
- .. raw:: html | ||
|
||
<div class="ansible-option-cell"> | ||
|
||
The resulting stuff. | ||
|
||
|
||
.. rst-class:: ansible-option-line | ||
|
||
:ansible-option-returned-bold:`Returned:` success | ||
|
||
|
||
.. raw:: html | ||
|
||
</div> | ||
|
||
|
||
|
||
.. Status (Presently only deprecated) | ||
.. Authors | ||
Authors | ||
~~~~~~~ | ||
|
||
- Felix Fontein (@felixfontein) | ||
|
||
|
||
.. hint:: | ||
Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. | ||
|
||
.. Extra links | ||
Collection links | ||
~~~~~~~~~~~~~~~~ | ||
|
||
.. raw:: html | ||
|
||
<p class="ansible-links"> | ||
<a href="https://github.com/ansible-collections/community.general/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> | ||
<a href="https://github.com/ansible-collections/community.crypto" aria-role="button" target="_blank" rel="noopener external">Homepage</a> | ||
<a href="https://github.com/ansible-collections/community.internal_test_tools" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> | ||
<a href="https://github.com/ansible-community/antsibull-docs/issues/new?assignees=&labels=&template=bug_report.md" aria-role="button" target="_blank" rel="noopener external">Submit a bug report</a> | ||
<a href="./#communication-for-ns2-col" aria-role="button" target="_blank">Communication</a> | ||
</p> | ||
|
||
.. Parsing errors | ||
Oops, something went wrong.