Use semantic markup.

Author: felixfontein

docs/docsite/rst/hosttech_guide.rst

@@ -21,7 +21,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
 
@@ -34,7 +34,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 <https://pypi.org/project/lxml/>`_ to work with the WSDL API. This can be done before using the modules:
 
@@ -110,7 +110,7 @@ The :ref:`community.dns.hosttech_dns_record_info module <ansible_collections.com
         msg: There is no A record for www.example.com
       when: not result.set
 
-In all examples in this section, you can replace ``zone_name: example.com`` by ``zone_id: 42`` with the zone's integer ID.
+In all examples in this section, you can replace :ansopt:`zone_name=example.com` by :ansopt:`zone_id=42` with the zone's integer ID.
 
 You can also query a list of all records for a record name or prefix:
 
@@ -169,7 +169,7 @@ The :ref:`community.dns.hosttech_dns_record module <ansible_collections.communit
         value: 1.1.1.1
         ttl: 300
 
-To delete records, simply use ``state: absent``. Records will be matched by record name and type, and the TTL will be ignored:
+To delete records, simply use :ansopt:`state=absent`. Records will be matched by record name and type, and the TTL will be ignored:
 
 .. code-block:: yaml+jinja
 
@@ -203,9 +203,9 @@ The :ref:`community.dns.hosttech_dns_record_set module <ansible_collections.comm
           - 1.1.1.1
           - 8.8.8.8
 
-If you want to assert that a record has a certain value, set ``on_existing: keep``. Using ``keep_and_warn`` instead will emit a warning if this happens, and ``keep_and_fail`` will make the module fail.
+If you want to assert that a record has a certain value, set :ansopt:`on_existing=keep`. Using :ansval:`keep_and_warn` instead will emit a warning if this happens, and :ansval:`keep_and_fail` will make the module fail.
 
-To delete values, you can either overwrite the values with value ``[]``, or use ``state: absent``:
+To delete values, you can either overwrite the values with value :ansval:`[]`, or use :ansopt:`state=absent`:
 
 .. code-block:: yaml+jinja
 
@@ -235,7 +235,7 @@ To delete values, you can either overwrite the values with value ``[]``, or use
         value:
           - '::1'
 
-In the third example, ``on_existing: keep_and_fail`` is present and an explicit value and TTL are given. This makes the module remove the current value only if there's a AAAA record for ``www.example.com`` whose current value is ``::1`` and whose TTL is 300. If another value is set, the module will not make any change, but fail. This can be useful to not accidentally remove values you do not want to change. To issue a warning instead of failing, use ``on_existing: keep_and_warn``, and to simply not do a change without any indication of this situation, use ``on_existing: keep``.
+In the third example, :ansopt:`on_existing=keep_and_fail` is present and an explicit value and TTL are given. This makes the module remove the current value only if there's a AAAA record for ``www.example.com`` whose current value is ``::1`` and whose TTL is 300. If another value is set, the module will not make any change, but fail. This can be useful to not accidentally remove values you do not want to change. To issue a warning instead of failing, use :ansopt:`on_existing=keep_and_warn`, and to simply not do a change without any indication of this situation, use :ansopt:`on_existing=keep`.
 
 Bulk synchronization of DNS record sets
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -260,7 +260,7 @@ The following example shows up to set/update multiple records at once:
             value:
               - '::1'
 
-The next example shows how to make sure that only the given records are available and all other records are deleted. Note that for the ``type: NS`` record we used ``ignore: true``, which allows us to skip the value. It tells the module that it should not touch the ``NS`` record for ``example.com``.
+The next example shows how to make sure that only the given records are available and all other records are deleted. Note that for the :ansopt:`type=NS` record we used :ansopt:`ignore=true`, which allows us to skip the value. It tells the module that it should not touch the ``NS`` record for ``example.com``.
 
 .. code-block:: yaml+jinja
 

plugins/doc_fragments/hetzner.py

@@ -15,7 +15,7 @@ class ModuleDocFragment(object):
     hetzner_token:
         description:
           - The token for the Hetzner API.
-          - If not provided, will be read from the environment variable C(HETZNER_DNS_TOKEN).
+          - If not provided, will be read from the environment variable E(HETZNER_DNS_TOKEN).
         aliases:
           - api_token
         type: str
@@ -56,15 +56,15 @@ class ModuleDocFragment(object):
             record:
                 description:
                   - The full DNS record to create or delete.
-                  - Exactly one of I(record) and I(prefix) must be specified.
+                  - Exactly one of O(record) and O(prefix) must be specified.
                 type: str
             prefix:
                 description:
                   - The prefix of the DNS record.
-                  - This is the part of I(record) before I(zone). For example, if the record to be modified is C(www.example.com)
-                    for the zone C(example.com), the prefix is C(www). If the record in this example would be C(example.com), the
-                    prefix would be C('') (empty string).
-                  - Exactly one of I(record) and I(prefix) must be specified.
+                  - This is the part of O(record) before O(zone). For example, if the record to be modified is C(www.example.com)
+                    for the zone C(example.com), the prefix is V(www). If the record in this example would be C(example.com), the
+                    prefix would be V('') (empty string).
+                  - Exactly one of O(record) and O(prefix) must be specified.
                 type: str
             ttl:
                 description:
@@ -77,13 +77,13 @@ class ModuleDocFragment(object):
                   - YAML lists or multiple comma-spaced values are allowed.
                   - When deleting a record all values for the record must be specified or it will
                     not be deleted.
-                  - Must be specified if I(ignore=false).
+                  - Must be specified if O(ignore=false).
                 type: list
                 elements: str
             ignore:
                 description:
-                  - If set to C(true), I(value) will be ignored.
-                  - This is useful when I(prune=true), but you do not want certain entries to be removed
+                  - If set to V(true), O(value) will be ignored.
+                  - This is useful when O(prune=true), but you do not want certain entries to be removed
                     without having to know their current value.
                 type: bool
                 default: false

plugins/doc_fragments/hosttech.py

@@ -18,20 +18,20 @@ class ModuleDocFragment(object):
     hosttech_username:
         description:
           - The username for the Hosttech API user.
-          - If provided, I(hosttech_password) must also be provided.
-          - Mutually exclusive with I(hosttech_token).
+          - If provided, O(hosttech_password) must also be provided.
+          - Mutually exclusive with O(hosttech_token).
         type: str
     hosttech_password:
         description:
           - The password for the Hosttech API user.
-          - If provided, I(hosttech_password) must also be provided.
-          - Mutually exclusive with I(hosttech_token).
+          - If provided, O(hosttech_password) must also be provided.
+          - Mutually exclusive with O(hosttech_token).
         type: str
     hosttech_token:
         description:
           - The password for the Hosttech API user.
-          - Mutually exclusive with I(hosttech_username) and I(hosttech_password).
-          - Since community.dns 1.2.0, the alias I(api_token) can be used.
+          - Mutually exclusive with O(hosttech_username) and O(hosttech_password).
+          - Since community.dns 1.2.0, the alias O(api_token) can be used.
         aliases:
           - api_token
         type: str
@@ -69,15 +69,15 @@ class ModuleDocFragment(object):
             record:
                 description:
                   - The full DNS record to create or delete.
-                  - Exactly one of I(record) and I(prefix) must be specified.
+                  - Exactly one of O(record) and O(prefix) must be specified.
                 type: str
             prefix:
                 description:
                   - The prefix of the DNS record.
-                  - This is the part of I(record) before I(zone). For example, if the record to be modified is C(www.example.com)
-                    for the zone C(example.com), the prefix is C(www). If the record in this example would be C(example.com), the
-                    prefix would be C('') (empty string).
-                  - Exactly one of I(record) and I(prefix) must be specified.
+                  - This is the part of O(record) before O(zone). For example, if the record to be modified is C(www.example.com)
+                    for the zone C(example.com), the prefix is V(www). If the record in this example would be C(example.com), the
+                    prefix would be V('') (empty string).
+                  - Exactly one of O(record) and O(prefix) must be specified.
                 type: str
             ttl:
                 description:
@@ -90,13 +90,13 @@ class ModuleDocFragment(object):
                   - YAML lists or multiple comma-spaced values are allowed.
                   - When deleting a record all values for the record must be specified or it will
                     not be deleted.
-                  - Must be specified if I(ignore=false).
+                  - Must be specified if O(ignore=false).
                 type: list
                 elements: str
             ignore:
                 description:
-                  - If set to C(true), I(value) will be ignored.
-                  - This is useful when I(prune=true), but you do not want certain entries to be removed
+                  - If set to V(true), O(value) will be ignored.
+                  - This is useful when O(prune=true), but you do not want certain entries to be removed
                     without having to know their current value.
                 type: bool
                 default: false

plugins/doc_fragments/inventory_records.py

@@ -19,14 +19,14 @@ class ModuleDocFragment(object):
     zone_name:
         description:
           - The DNS zone to modify.
-          - Exactly one of I(zone_name) and I(zone_id) must be specified.
+          - Exactly one of O(zone_name) and O(zone_id) must be specified.
         type: str
         aliases:
           - zone
     zone_id:
         description:
           - The ID of the DNS zone to modify.
-          - Exactly one of I(zone_name) and I(zone_id) must be specified.
+          - Exactly one of O(zone_name) and O(zone_id) must be specified.
     filters:
         description:
           - A dictionary of filter value pairs.

plugins/doc_fragments/module_record.py

@@ -24,26 +24,26 @@ class ModuleDocFragment(object):
     zone_name:
         description:
           - The DNS zone to modify.
-          - Exactly one of I(zone_name) and I(zone_id) must be specified.
+          - Exactly one of O(zone_name) and O(zone_id) must be specified.
         type: str
         aliases:
           - zone
     zone_id:
         description:
           - The ID of the DNS zone to modify.
-          - Exactly one of I(zone_name) and I(zone_id) must be specified.
+          - Exactly one of O(zone_name) and O(zone_id) must be specified.
     record:
         description:
           - The full DNS record to create or delete.
-          - Exactly one of I(record) and I(prefix) must be specified.
+          - Exactly one of O(record) and O(prefix) must be specified.
         type: str
     prefix:
         description:
           - The prefix of the DNS record.
-          - This is the part of I(record) before I(zone_name). For example, if the record to be modified is C(www.example.com)
-            for the zone C(example.com), the prefix is C(www). If the record in this example would be C(example.com), the
-            prefix would be C('') (empty string).
-          - Exactly one of I(record) and I(prefix) must be specified.
+          - This is the part of O(record) before O(zone_name). For example, if the record to be modified is C(www.example.com)
+            for the zone C(example.com), the prefix is V(www). If the record in this example would be C(example.com), the
+            prefix would be V('') (empty string).
+          - Exactly one of O(record) and O(prefix) must be specified.
         type: str
     ttl:
         description:

plugins/doc_fragments/module_record_info.py

@@ -23,33 +23,33 @@ class ModuleDocFragment(object):
     zone_name:
         description:
           - The DNS zone to modify.
-          - Exactly one of I(zone) and I(zone_id) must be specified.
+          - Exactly one of O(zone) and O(zone_id) must be specified.
         type: str
         aliases:
           - zone
     zone_id:
         description:
           - The ID of the DNS zone to modify.
-          - Exactly one of I(zone_name) and I(zone_id) must be specified.
+          - Exactly one of O(zone_name) and O(zone_id) must be specified.
         version_added: 0.2.0
     record:
         description:
           - The full DNS record to retrieve.
-          - If I(what) is C(single_record) or C(all_types_for_record), exactly one of I(record) and I(prefix) is required.
+          - If O(what) is V(single_record) or V(all_types_for_record), exactly one of O(record) and O(prefix) is required.
         type: str
     prefix:
         description:
           - The prefix of the DNS record.
-          - This is the part of I(record) before I(zone_name). For example, if the record to be modified is C(www.example.com)
-            for the zone C(example.com), the prefix is C(www). If the record in this example would be C(example.com), the
-            prefix would be C('') (empty string).
-          - If I(what) is C(single_record) or C(all_types_for_record), exactly one of I(record) and I(prefix) is required.
+          - This is the part of O(record) before O(zone_name). For example, if the record to be modified is C(www.example.com)
+            for the zone C(example.com), the prefix is V(www). If the record in this example would be C(example.com), the
+            prefix would be V('') (empty string).
+          - If O(what) is V(single_record) or V(all_types_for_record), exactly one of O(record) and O(prefix) is required.
         type: str
         version_added: 0.2.0
     type:
         description:
           - The type of DNS record to retrieve.
-          - Required if I(what) is C(single_record).
+          - Required if O(what) is V(single_record).
         type: str
 
 notes: