diff --git a/docs/docsite/rst/filter_guide.rst b/docs/docsite/rst/filter_guide.rst index a2169369..e6f9f082 100644 --- a/docs/docsite/rst/filter_guide.rst +++ b/docs/docsite/rst/filter_guide.rst @@ -45,23 +45,23 @@ The filters also allow additional options (keyword arguments): :keep_unknown_suffix: - A boolean with default value ``true``. This treats unknown TLDs as valid public suffixes. So for example the public suffix of ``example.tlddoesnotexist`` is ``.tlddoesnotexist`` if this is ``true``. If set to ``false``, it will return an empty string in this case. This option corresponds to whether the global wildcard rule ``*`` in the Public Suffix List is used or not. + A boolean with default value :ansval:`true`. This treats unknown TLDs as valid public suffixes. So for example the public suffix of :ansval:`example.tlddoesnotexist` is ``.tlddoesnotexist`` if this is :ansval:`true`. If set to :ansval:`false`, it will return an empty string in this case. This option corresponds to whether the global wildcard rule ``*`` in the Public Suffix List is used or not. :icann_only: - A boolean with default value ``false``. This controls whether only entries from the ICANN section of the Public Suffix List are used, or also entries from the Private section. For example, ``.co.uk`` is in the ICANN section, but ``github.io`` is in the Private section. + A boolean with default value :ansval:`false`. This controls whether only entries from the ICANN section of the Public Suffix List are used, or also entries from the Private section. For example, ``.co.uk`` is in the ICANN section, but ``github.io`` is in the Private section. :normalize_result: - (Only for :ref:`community.dns.get_public_suffix `) A boolean with default value ``false``. This controls whether the result is reconstructed from the normalized name used during lookup. During normalization, ulabels are converted to alabels, and every label is converted to lowercase. For example, the ulabel ``ëçãmplê`` is converted to ``xn--mpl-llatwb`` (puny-code), and ``Example.COM`` is converted to ``example.com``. + (Only for :ref:`community.dns.get_public_suffix `) A boolean with default value :ansval:`false`. This controls whether the result is reconstructed from the normalized name used during lookup. During normalization, ulabels are converted to alabels, and every label is converted to lowercase. For example, the ulabel :ansval:`ëçãmplê` is converted to ``xn--mpl-llatwb`` (puny-code), and :ansval:`Example.COM` is converted to ``example.com``. :keep_leading_period: - (Only for :ref:`community.dns.get_public_suffix `) A boolean with default value ``true``. This controls whether the leading period of a public suffix is preserved or not. + (Only for :ref:`community.dns.get_public_suffix `) A boolean with default value :ansval:`true`. This controls whether the leading period of a public suffix is preserved or not. :keep_trailing_period: - (Only for :ref:`community.dns.remove_public_suffix `) A boolean with default value ``false``. This controls whether the trailing period of the prefix (that is, the part before the public suffix) is preserved or not. + (Only for :ref:`community.dns.remove_public_suffix `) A boolean with default value :ansval:`false`. This controls whether the trailing period of the prefix (that is, the part before the public suffix) is preserved or not. Working with registrable domain names ------------------------------------- @@ -85,20 +85,20 @@ The filters also allow additional options (keyword arguments): :keep_unknown_suffix: - A boolean with default value ``true``. This treats unknown TLDs as valid public suffixes. So for example the public suffix of ``example.tlddoesnotexist`` is ``.tlddoesnotexist`` if this is ``true``, and hence the registrable domain of ``www.example.tlddoesnotexist`` is ``example.tlddoesnotexist``. If set to ``false``, the registrable domain of ``www.example.tlddoesnotexist`` is ``tlddoesnotexist``. This option corresponds to whether the global wildcard rule ``*`` in the Public Suffix List is used or not. + A boolean with default value :ansval:`true`. This treats unknown TLDs as valid public suffixes. So for example the public suffix of :ansval:`example.tlddoesnotexist` is ``.tlddoesnotexist`` if this is :ansval:`true`, and hence the registrable domain of :ansval:`www.example.tlddoesnotexist` is ``example.tlddoesnotexist``. If set to :ansval:`false`, the registrable domain of :ansval:`www.example.tlddoesnotexist` is ``tlddoesnotexist``. This option corresponds to whether the global wildcard rule ``*`` in the Public Suffix List is used or not. :icann_only: - A boolean with default value ``false``. This controls whether only entries from the ICANN section of the Public Suffix List are used, or also entries from the Private section. For example, ``.co.uk`` is in the ICANN section, but ``github.io`` is in the Private section. + A boolean with default value :ansval:`false`. This controls whether only entries from the ICANN section of the Public Suffix List are used, or also entries from the Private section. For example, ``.co.uk`` is in the ICANN section, but ``github.io`` is in the Private section. :only_if_registerable: - A boolean with default value ``true``. This controls the behavior in case there is no label in front of the public suffix. This is the case if the DNS name itself is a public suffix. If set to ``false``, in this case the public suffix is treated as a registrable domain. If set to ``true`` (default), the registrable domain of a public suffix is interpreted as an empty string. + A boolean with default value :ansval:`true`. This controls the behavior in case there is no label in front of the public suffix. This is the case if the DNS name itself is a public suffix. If set to :ansval:`false`, in this case the public suffix is treated as a registrable domain. If set to :ansval:`true` (default), the registrable domain of a public suffix is interpreted as an empty string. :normalize_result: - (Only for :ref:`community.dns.get_registrable_domain `) A boolean with default value ``false``. This controls whether the result is reconstructed from the normalized name used during lookup. During normalization, ulabels are converted to alabels, and every label is converted to lowercase. For example, the ulabel ``ëçãmplê`` is converted to ``xn--mpl-llatwb`` (puny-code), and ``Example.COM`` is converted to ``example.com``. + (Only for :ref:`community.dns.get_registrable_domain `) A boolean with default value :ansval:`false`. This controls whether the result is reconstructed from the normalized name used during lookup. During normalization, ulabels are converted to alabels, and every label is converted to lowercase. For example, the ulabel :ansval:`ëçãmplê` is converted to ``xn--mpl-llatwb`` (puny-code), and :ansval:`Example.COM` is converted to ``example.com``. :keep_trailing_period: - (Only for :ref:`community.dns.remove_registrable_domain `) A boolean with default value ``false``. This controls whether the trailing period of the prefix (that is, the part before the registrable domain) is preserved or not. + (Only for :ref:`community.dns.remove_registrable_domain `) A boolean with default value :ansval:`false`. This controls whether the trailing period of the prefix (that is, the part before the registrable domain) is preserved or not. diff --git a/docs/docsite/rst/hetzner_guide.rst b/docs/docsite/rst/hetzner_guide.rst index cbb029dc..685cdd85 100644 --- a/docs/docsite/rst/hetzner_guide.rst +++ b/docs/docsite/rst/hetzner_guide.rst @@ -33,7 +33,7 @@ It also provides an inventory plugin: Authentication -------------- -To use Hetzner's API, you need to create an API token. You can manage API tokens in the "API tokens" menu entry in your user menu in the `DNS Console `_. You must provide the token to the ``hetzner_token`` option of the modules, its alias ``api_token``, or pass it on in the ``HETZNER_DNS_TOKEN`` environment variable: +To use Hetzner's API, you need to create an API token. You can manage API tokens in the "API tokens" menu entry in your user menu in the `DNS Console `_. You must provide the token to the :ansopt:`hetzner_token` option of the modules, its alias :ansopt:`api_token`, or pass it on in the :envvar:`HETZNER_DNS_TOKEN` environment variable: .. code-block:: yaml+jinja @@ -105,7 +105,7 @@ Working with DNS records .. note:: - By default, TXT record values returned and accepted by the modules and plugins in this collection are unquoted. This means that you do not have to add double quotes (``"``), and escape double quotes (as ``\"``) and backslashes (as ``\\``). All modules and plugins which work with DNS records support the ``txt_transformation`` option which allows to configure this behavior. + By default, TXT record values returned and accepted by the modules and plugins in this collection are unquoted. This means that you do not have to add double quotes (``"``), and escape double quotes (as ``\"``) and backslashes (as ``\\``). All modules and plugins which work with DNS records support the :ansopt:`community.dns.hetzner_dns_record_set#module:txt_transformation` option which allows to configure this behavior. Querying DNS records and record sets ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -137,7 +137,7 @@ The :ref:`community.dns.hetzner_dns_record_set_info module ` and the :ref:`community.dns.hetzner_dns_record_set module `, depending on what it is used for. -When creating, updating or removing single records, the :ref:`community.dns.hetzner_dns_record module ` should be used. This is the case when ``purge=false`` is specified (the default value). Note that ``replace``, ``overwrite`` and ``solo`` are aliases of ``purge``. +When creating, updating or removing single records, the :ref:`community.dns.hetzner_dns_record module ` should be used. This is the case when :ansopt:`purge=false` is specified (the default value). Note that :ansopt:`replace`, :ansopt:`overwrite` and :ansopt:`solo` are aliases of :ansopt:`purge`. .. code-block:: yaml+jinja @@ -410,7 +410,7 @@ When the ``markuman.hetzner_dns.record`` module is in replace mode, it should be # or keep the following option: txt_transformation: api -When deleting a record, it depends on whether ``value`` is specified or not. If ``value`` is specified, the module is deleting a single DNS record, and the :ref:`community.dns.hetzner_dns_record module ` should be used: +When deleting a record, it depends on whether :ansopt:`value` is specified or not. If :ansopt:`value` is specified, the module is deleting a single DNS record, and the :ref:`community.dns.hetzner_dns_record module ` should be used: .. code-block:: yaml+jinja @@ -440,7 +440,7 @@ When deleting a record, it depends on whether ``value`` is specified or not. If # or keep the following option: txt_transformation: api -When ``value`` is not specified, the ``markuman.hetzner_dns.record`` module will delete all records for this prefix and type. In that case, it operates on a record set and the :ref:`community.dns.hetzner_dns_record_set module ` should be used: +When :ansopt:`value` is not specified, the ``markuman.hetzner_dns.record`` module will delete all records for this prefix and type. In that case, it operates on a record set and the :ref:`community.dns.hetzner_dns_record_set module ` should be used: .. code-block:: yaml+jinja @@ -463,20 +463,20 @@ When ``value`` is not specified, the ``markuman.hetzner_dns.record`` module will # 'type' does not change: type: A -A last step is replacing the deprecated alias ``name`` of ``prefix`` by ``prefix``. This can be done later though, if you do not mind the deprecation warnings. +A last step is replacing the deprecated alias :ansopt:`community.dns.hetzner_dns_record_set#module:name` of :ansopt:`community.dns.hetzner_dns_record_set#module:prefix` by :ansopt:`community.dns.hetzner_dns_record_set#module:prefix`. This can be done later though, if you do not mind the deprecation warnings. The markuman.hetzner_dns.record_info module ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The ``markuman.hetzner_dns.record_info`` module can be replaced by the :ref:`community.dns.hetzner_dns_record_info module `. The main difference is that instead of by the ``filters`` option, the output is controlled by the ``what`` option (choices ``single_record``, ``all_types_for_record``, and ``all_records``), the ``type`` option (needed when ``what=single_record``), and the ``record`` and ``prefix`` options (needed when ``what`` is not ``all_records``). +The ``markuman.hetzner_dns.record_info`` module can be replaced by the :ref:`community.dns.hetzner_dns_record_info module `. The main difference is that instead of by the :ansopt:`filters` option, the output is controlled by the :ansopt:`community.dns.hetzner_dns_record_info#module:what` option (choices :ansval:`single_record`, :ansval:`all_types_for_record`, and :ansval:`all_records`), the :ansopt:`community.dns.hetzner_dns_record_info#module:type` option (needed when :ansopt:`community.dns.hetzner_dns_record_info#module:what=single_record`), and the :ansopt:`community.dns.hetzner_dns_record_info#module:record` and :ansopt:`community.dns.hetzner_dns_record_info#module:prefix` options (needed when :ansopt:`community.dns.hetzner_dns_record_info#module:what` is not :ansval:`all_records`). The markuman.hetzner_dns.zone_info module ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The ``markuman.hetzner_dns.zone_info`` module can be replaced by the :ref:`community.dns.hetzner_dns_zone_info module `. The main differences are: -1. The parameter ``name`` must be changed to ``zone_name`` or ``zone``. -2. The return value ``zone_info`` no longer has the ``name`` and ``id`` entries. Use the return values ``zone_name`` and ``zone_id`` instead. +1. The parameter :ansopt:`name` must be changed to :ansopt:`community.dns.hetzner_dns_zone_info#module:zone_name` or :ansopt:`community.dns.hetzner_dns_zone_info#module:zone`. +2. The return value :ansretval:`community.dns.hetzner_dns_zone_info#module:zone_info` no longer has the ``name`` and ``id`` entries. Use the return values :ansretval:`community.dns.hetzner_dns_zone_info#module:zone_name` and :ansretval:`community.dns.hetzner_dns_zone_info#module:zone_id` instead. The markuman.hetzner_dns.inventory inventory plugin ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/docsite/rst/hosttech_guide.rst b/docs/docsite/rst/hosttech_guide.rst index 8efb8058..d9ce7750 100644 --- a/docs/docsite/rst/hosttech_guide.rst +++ b/docs/docsite/rst/hosttech_guide.rst @@ -36,7 +36,7 @@ HostTech currently has two APIs for working with DNS records: the old WSDL-based JSON REST API ~~~~~~~~~~~~~ -To use the JSON REST API, you need to create a API token. You can manage API tokens in the "DNS Editor" in the "API" section. You must provide the token to the ``hosttech_token`` option of the modules: +To use the JSON REST API, you need to create a API token. You can manage API tokens in the "DNS Editor" in the "API" section. You must provide the token to the :ansopt:`hosttech_token` option of the modules: .. code-block:: yaml+jinja @@ -49,7 +49,7 @@ In the examples in this guide, we will leave the authentication options away. Pl WSDL API ~~~~~~~~ -To use the WSDL API, you need to set API credentials. These can be found and changed in the "Servercenter" and there in the "Solutions" section under settings for the "DNS Tool". The username is fixed, but the password can be changed. The credentials must be provided to the ``hosttech_username`` and ``hosttech_password`` options of the modules. +To use the WSDL API, you need to set API credentials. These can be found and changed in the "Servercenter" and there in the "Solutions" section under settings for the "DNS Tool". The username is fixed, but the password can be changed. The credentials must be provided to the :ansopt:`hosttech_username` and :ansopt:`hosttech_password` options of the modules. You also need to install the `lxml Python module `_ to work with the WSDL API. This can be done before using the modules: @@ -129,7 +129,7 @@ Working with DNS records .. note:: - By default, TXT record values returned and accepted by the modules and plugins in this collection are unquoted. This means that you do not have to add double quotes (``"``), and escape double quotes (as ``\"``) and backslashes (as ``\\``). All modules and plugins which work with DNS records support the ``txt_transformation`` option which allows to configure this behavior. + By default, TXT record values returned and accepted by the modules and plugins in this collection are unquoted. This means that you do not have to add double quotes (``"``), and escape double quotes (as ``\"``) and backslashes (as ``\\``). All modules and plugins which work with DNS records support the :ansopt:`community.dns.hosttech_dns_record_set#module:txt_transformation` option which allows to configure this behavior. Querying DNS records and record sets ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -161,7 +161,7 @@ The :ref:`community.dns.hosttech_dns_record_set_info module diff --git a/plugins/inventory/hosttech_dns_records.py b/plugins/inventory/hosttech_dns_records.py index aa840510..3f688aaf 100644 --- a/plugins/inventory/hosttech_dns_records.py +++ b/plugins/inventory/hosttech_dns_records.py @@ -23,7 +23,7 @@ options: plugin: - description: The name of this plugin. Should always be set to C(community.dns.hosttech_dns_records) for this plugin to recognize it as its own. + description: The name of this plugin. Should always be set to V(community.dns.hosttech_dns_records) for this plugin to recognize it as its own. # TODO: add `required: true` in 3.0.0 # required: true choices: @@ -47,7 +47,7 @@ - community.dns.options.record_transformation notes: - - The provider-specific I(hosttech_username), I(hosttech_password), and I(hosttech_token) options can be templated. + - The provider-specific O(hosttech_username), O(hosttech_password), and O(hosttech_token) options can be templated. author: - Markus Bergholz (@markuman) diff --git a/plugins/modules/hetzner_dns_record_info.py b/plugins/modules/hetzner_dns_record_info.py index 9d77a38d..edf65aac 100644 --- a/plugins/modules/hetzner_dns_record_info.py +++ b/plugins/modules/hetzner_dns_record_info.py @@ -37,6 +37,11 @@ author: - Markus Bergholz (@markuman) - Felix Fontein (@felixfontein) + +seealso: + - module: community.dns.hetzner_dns_record_set_info + - plugin: community.dns.hetzner_dns_records + plugin_type: inventory ''' EXAMPLES = ''' @@ -58,7 +63,7 @@ description: The list of fetched records. type: list elements: dict - returned: success and I(what) is not C(single_record) + returned: success and O(what) is not V(single_record) contains: record: description: The record name. @@ -75,7 +80,7 @@ ttl: description: - The TTL. - - Will return C(none) if the zone's default TTL is used. + - Will return V(none) if the zone's default TTL is used. type: int sample: 3600 value: diff --git a/plugins/modules/hetzner_dns_record_set_info.py b/plugins/modules/hetzner_dns_record_set_info.py index 5c70d1fb..2df5d0f7 100644 --- a/plugins/modules/hetzner_dns_record_set_info.py +++ b/plugins/modules/hetzner_dns_record_set_info.py @@ -37,6 +37,11 @@ author: - Markus Bergholz (@markuman) - Felix Fontein (@felixfontein) + +seealso: + - module: community.dns.hetzner_dns_record_info + - plugin: community.dns.hetzner_dns_records + plugin_type: inventory ''' EXAMPLES = ''' @@ -57,7 +62,7 @@ set: description: The fetched record set. Is empty if record set does not exist. type: dict - returned: success and I(what) is C(single_record) + returned: success and O(what) is V(single_record) contains: record: description: The record name. @@ -76,7 +81,7 @@ description: - The TTL. - If there are records in this set with different TTLs, the minimum of the TTLs will be presented here. - - Will return C(none) if the zone's default TTL is used. + - Will return V(none) if the zone's default TTL is used. type: int sample: 3600 ttls: @@ -109,7 +114,7 @@ description: The list of fetched record sets. type: list elements: dict - returned: success and I(what) is not C(single_record) + returned: success and O(what) is not V(single_record) contains: record: description: The record name. @@ -128,7 +133,7 @@ description: - The TTL. - If there are records in this set with different TTLs, the minimum of the TTLs will be presented here. - - Will return C(none) if the zone's default TTL is used. + - Will return V(none) if the zone's default TTL is used. type: int sample: 3600 ttls: diff --git a/plugins/modules/hetzner_dns_zone_info.py b/plugins/modules/hetzner_dns_zone_info.py index 44cc88af..9f4626e0 100644 --- a/plugins/modules/hetzner_dns_zone_info.py +++ b/plugins/modules/hetzner_dns_zone_info.py @@ -121,7 +121,7 @@ status: description: - Status of the zone. - - Can be one of C(verified), C(failed) and C(pending). + - Can be one of V(verified), V(failed) and V(pending). type: str sample: verified # choices: diff --git a/plugins/modules/hosttech_dns_record_info.py b/plugins/modules/hosttech_dns_record_info.py index 84ee8e3b..71004464 100644 --- a/plugins/modules/hosttech_dns_record_info.py +++ b/plugins/modules/hosttech_dns_record_info.py @@ -36,6 +36,11 @@ author: - Felix Fontein (@felixfontein) + +seealso: + - module: community.dns.hosttech_dns_record_set_info + - plugin: community.dns.hosttech_dns_records + plugin_type: inventory ''' EXAMPLES = ''' @@ -57,7 +62,7 @@ description: The list of fetched records. type: list elements: dict - returned: success and I(what) is not C(single_record) + returned: success and O(what) is not V(single_record) contains: record: description: The record name. diff --git a/plugins/modules/hosttech_dns_record_set_info.py b/plugins/modules/hosttech_dns_record_set_info.py index 5b7c576b..60a54809 100644 --- a/plugins/modules/hosttech_dns_record_set_info.py +++ b/plugins/modules/hosttech_dns_record_set_info.py @@ -19,7 +19,7 @@ description: - "Retrieves DNS record sets in Hosttech DNS service." - - This module was renamed from C(community.dns.hosttech_dns_record_info) to C(community.dns.hosttech_dns_record_set_info) + - This module was renamed from C(community.dns.hosttech_dns_record_info) to M(community.dns.hosttech_dns_record_set_info) in community.dns 2.0.0. extends_documentation_fragment: @@ -38,6 +38,11 @@ author: - Felix Fontein (@felixfontein) + +seealso: + - module: community.dns.hosttech_dns_record_info + - plugin: community.dns.hosttech_dns_records + plugin_type: inventory ''' EXAMPLES = ''' @@ -58,7 +63,7 @@ set: description: The fetched record set. Is empty if record set does not exist. type: dict - returned: success and I(what) is C(single_record) + returned: success and O(what=single_record) contains: record: description: The record name. @@ -109,7 +114,7 @@ description: The list of fetched record sets. type: list elements: dict - returned: success and I(what) is not C(single_record) + returned: success and O(what=single_record) contains: record: description: The record name. diff --git a/plugins/modules/hosttech_dns_zone_info.py b/plugins/modules/hosttech_dns_zone_info.py index 6621893a..d364d069 100644 --- a/plugins/modules/hosttech_dns_zone_info.py +++ b/plugins/modules/hosttech_dns_zone_info.py @@ -80,22 +80,22 @@ description: - Whether DNSSEC is enabled for the zone or not. type: bool - returned: When I(hosttech_token) has been specified. + returned: When O(hosttech_token) has been specified. dnssec_email: description: - The email address contacted when the DNSSEC key is changed. - - Is C(none) if DNSSEC is not enabled. + - Is V(none) if DNSSEC is not enabled. type: str - returned: When I(hosttech_token) has been specified. + returned: When O(hosttech_token) has been specified. ds_records: description: - The DS records. - See L(Section 5 of RFC 4034,https://datatracker.ietf.org/doc/html/rfc4034#section-5) and L(Section 2.1 of RFC 4034,https://datatracker.ietf.org/doc/html/rfc4034#section-2.1) for details. - - Is C(none) if DNSSEC is not enabled. + - Is V(none) if DNSSEC is not enabled. type: list elements: dict - returned: When I(hosttech_token) has been specified. + returned: When O(hosttech_token) has been specified. contains: algorithm: description: diff --git a/plugins/modules/wait_for_txt.py b/plugins/modules/wait_for_txt.py index 1a09c5ed..5378d20c 100644 --- a/plugins/modules/wait_for_txt.py +++ b/plugins/modules/wait_for_txt.py @@ -40,7 +40,7 @@ suboptions: name: description: - - A DNS name, like C(www.example.com). + - A DNS name, like V(www.example.com). type: str required: true values: @@ -51,17 +51,17 @@ required: true mode: description: - - Comparison modes for the values in I(values). - - If C(subset), I(values) should be a (not necessarily proper) subset of the TXT values set for + - Comparison modes for the values in O(records[].values). + - If V(subset), O(records[].values) should be a (not necessarily proper) subset of the TXT values set for the DNS name. - - If C(superset), I(values) should be a (not necessarily proper) superset of the TXT values set + - If V(superset), O(records[].values) should be a (not necessarily proper) superset of the TXT values set for the DNS name. This includes the case that no TXT entries are set. - - If C(superset_not_empty), I(values) should be a (not necessarily proper) superset of the TXT + - If V(superset_not_empty), O(records[].values) should be a (not necessarily proper) superset of the TXT values set for the DNS name, assuming at least one TXT record is present. - - If C(equals), I(values) should be the same set of strings as the TXT values for the DNS name + - If V(equals), O(records[].values) should be the same set of strings as the TXT values for the DNS name (up to order). - - If C(equals_ordered), I(values) should be the same ordered list of strings as the TXT values + - If V(equals_ordered), O(records[].values) should be the same ordered list of strings as the TXT values for the DNS name. type: str default: subset @@ -93,9 +93,9 @@ default: 10 always_ask_default_resolver: description: - - When set to C(true) (default), will use the default resolver to find the authoritative nameservers + - When set to V(true) (default), will use the default resolver to find the authoritative nameservers of a subzone. - - When set to C(false), will use the authoritative nameservers of the parent zone to find the + - When set to V(false), will use the authoritative nameservers of the parent zone to find the authoritative nameservers of a subzone. This only makes sense when the nameservers were recently changed and haven't propagated. type: bool @@ -124,7 +124,7 @@ records: description: - Results on the TXT records queried. - - The entries are in a 1:1 correspondence to the entries of the I(records) parameter, + - The entries are in a 1:1 correspondence to the entries of the O(records) parameter, in exactly the same order. returned: always type: list diff --git a/tests/sanity/extra/extra-docs.py b/tests/sanity/extra/extra-docs.py index c636beb0..251e6d70 100755 --- a/tests/sanity/extra/extra-docs.py +++ b/tests/sanity/extra/extra-docs.py @@ -17,7 +17,7 @@ def main(): suffix = ':{env}'.format(env=env["ANSIBLE_COLLECTIONS_PATH"]) if 'ANSIBLE_COLLECTIONS_PATH' in env else '' env['ANSIBLE_COLLECTIONS_PATH'] = '{root}{suffix}'.format(root=os.path.dirname(os.path.dirname(os.path.dirname(os.getcwd()))), suffix=suffix) p = subprocess.run( - ['antsibull-docs', 'lint-collection-docs', '--plugin-docs', '--disallow-semantic-markup', '--skip-rstcheck', '.'], + ['antsibull-docs', 'lint-collection-docs', '--plugin-docs', '--skip-rstcheck', '.'], env=env, check=False, ) diff --git a/tests/sanity/ignore-2.10.txt b/tests/sanity/ignore-2.10.txt index dc9da116..14ec3bed 100644 --- a/tests/sanity/ignore-2.10.txt +++ b/tests/sanity/ignore-2.10.txt @@ -1 +1,8 @@ +docs/docsite/rst/filter_guide.rst rstcheck +docs/docsite/rst/hosttech_guide.rst rstcheck +docs/docsite/rst/hetzner_guide.rst rstcheck +plugins/modules/hetzner_dns_record_info.py validate-modules:invalid-documentation +plugins/modules/hetzner_dns_record_set_info.py validate-modules:invalid-documentation +plugins/modules/hosttech_dns_record_info.py validate-modules:invalid-documentation +plugins/modules/hosttech_dns_record_set_info.py validate-modules:invalid-documentation plugins/public_suffix_list.dat no-smart-quotes diff --git a/tests/sanity/ignore-2.11.txt b/tests/sanity/ignore-2.11.txt index dc9da116..593a5082 100644 --- a/tests/sanity/ignore-2.11.txt +++ b/tests/sanity/ignore-2.11.txt @@ -1 +1,5 @@ +plugins/modules/hetzner_dns_record_info.py validate-modules:invalid-documentation +plugins/modules/hetzner_dns_record_set_info.py validate-modules:invalid-documentation +plugins/modules/hosttech_dns_record_info.py validate-modules:invalid-documentation +plugins/modules/hosttech_dns_record_set_info.py validate-modules:invalid-documentation plugins/public_suffix_list.dat no-smart-quotes diff --git a/tests/sanity/ignore-2.12.txt b/tests/sanity/ignore-2.12.txt index dc9da116..593a5082 100644 --- a/tests/sanity/ignore-2.12.txt +++ b/tests/sanity/ignore-2.12.txt @@ -1 +1,5 @@ +plugins/modules/hetzner_dns_record_info.py validate-modules:invalid-documentation +plugins/modules/hetzner_dns_record_set_info.py validate-modules:invalid-documentation +plugins/modules/hosttech_dns_record_info.py validate-modules:invalid-documentation +plugins/modules/hosttech_dns_record_set_info.py validate-modules:invalid-documentation plugins/public_suffix_list.dat no-smart-quotes diff --git a/tests/sanity/ignore-2.13.txt b/tests/sanity/ignore-2.13.txt index dc9da116..593a5082 100644 --- a/tests/sanity/ignore-2.13.txt +++ b/tests/sanity/ignore-2.13.txt @@ -1 +1,5 @@ +plugins/modules/hetzner_dns_record_info.py validate-modules:invalid-documentation +plugins/modules/hetzner_dns_record_set_info.py validate-modules:invalid-documentation +plugins/modules/hosttech_dns_record_info.py validate-modules:invalid-documentation +plugins/modules/hosttech_dns_record_set_info.py validate-modules:invalid-documentation plugins/public_suffix_list.dat no-smart-quotes diff --git a/tests/sanity/ignore-2.14.txt b/tests/sanity/ignore-2.14.txt index dc9da116..593a5082 100644 --- a/tests/sanity/ignore-2.14.txt +++ b/tests/sanity/ignore-2.14.txt @@ -1 +1,5 @@ +plugins/modules/hetzner_dns_record_info.py validate-modules:invalid-documentation +plugins/modules/hetzner_dns_record_set_info.py validate-modules:invalid-documentation +plugins/modules/hosttech_dns_record_info.py validate-modules:invalid-documentation +plugins/modules/hosttech_dns_record_set_info.py validate-modules:invalid-documentation plugins/public_suffix_list.dat no-smart-quotes diff --git a/tests/sanity/ignore-2.9.txt b/tests/sanity/ignore-2.9.txt index dc9da116..14ec3bed 100644 --- a/tests/sanity/ignore-2.9.txt +++ b/tests/sanity/ignore-2.9.txt @@ -1 +1,8 @@ +docs/docsite/rst/filter_guide.rst rstcheck +docs/docsite/rst/hosttech_guide.rst rstcheck +docs/docsite/rst/hetzner_guide.rst rstcheck +plugins/modules/hetzner_dns_record_info.py validate-modules:invalid-documentation +plugins/modules/hetzner_dns_record_set_info.py validate-modules:invalid-documentation +plugins/modules/hosttech_dns_record_info.py validate-modules:invalid-documentation +plugins/modules/hosttech_dns_record_set_info.py validate-modules:invalid-documentation plugins/public_suffix_list.dat no-smart-quotes