ansible/test/integration/targets/ansible-doc/test_docs_suboptions.output

> TEST_DOCS_SUBOPTIONS    (library/test_docs_suboptions.py)

        Test module

OPTIONS (= is mandatory):

- with_suboptions
        An option with suboptions.
        Use with care.
        [Default: (null)]
        type: dict

        SUBOPTIONS:

        - a_first
            The first suboption.
            [Default: (null)]
            type: str

        - m_middle
            The suboption in the middle.
            Has its own suboptions.
            [Default: (null)]

            SUBOPTIONS:

            - a_suboption
                A sub-suboption.
                [Default: (null)]
                type: str

        - z_last
            The last suboption.
            [Default: (null)]
            type: str


AUTHOR: Ansible Core Team

EXAMPLES:
Plugin/module docs: parse return values, add collection names in them (version_added_collection), and format them nicely in ansible-doc (#69796) * Tag return value docs if they are a dict (and not str/None). * Try to parse return docs as YAML. * Properly dump return values in ansible-doc. * Adjust plugin formatter. * Add changelog fragment. * Don't add 'default' for return values. * Fix plugin_formatter. * Only try to parse return docs if they are still a string. * Add tests. * Warn if RETURN cannot be parsed. * Adjust tests. Also test for warning. * if -> elif (otherwise EXAMPLE will be parsed too). * Always parse return documentation, and fail if it is invalid YAML. * Polishing. * Mostly re-enable ansible-doc tests. Listing from the local collection seems to be somewhat broken. I assume this is why the test was disabled. * Lint and make tests work with Python 2. * Keep FQCNs in plugins (not modules), i.e. restore previous state. 2020-06-11 20:03:43 +02:00			`> TEST_DOCS_SUBOPTIONS (library/test_docs_suboptions.py)`
ansible-doc: properly handle suboptions (#69795) * Specifically handle suboptions, contains, etc in ansible-doc. 2020-06-08 17:51:33 +02:00
			`Test module`

			`OPTIONS (= is mandatory):`

			`- with_suboptions`
			`An option with suboptions.`
			`Use with care.`
			`[Default: (null)]`
			`type: dict`

			`SUBOPTIONS:`

			`- a_first`
			`The first suboption.`
			`[Default: (null)]`
			`type: str`

			`- m_middle`
			`The suboption in the middle.`
			`Has its own suboptions.`
			`[Default: (null)]`

			`SUBOPTIONS:`

			`- a_suboption`
			`A sub-suboption.`
			`[Default: (null)]`
			`type: str`

			`- z_last`
			`The last suboption.`
			`[Default: (null)]`
			`type: str`


			`AUTHOR: Ansible Core Team`

			`EXAMPLES:`