[PR #8875/4123934b backport][stable-9] reformat module docs (#8878)
reformat xfconf docs (#8875)
* reformat module docs
* fix sanity
(cherry picked from commit 4123934b46)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
pull/8881/head
patchback[bot]
GitHub
parent
5222df306b
commit
374378beeb
|
|
@ -8,26 +8,27 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
DOCUMENTATION = """
|
||||
---
|
||||
module: xfconf
|
||||
author:
|
||||
- "Joseph Benden (@jbenden)"
|
||||
- "Alexei Znamensky (@russoz)"
|
||||
- "Joseph Benden (@jbenden)"
|
||||
- "Alexei Znamensky (@russoz)"
|
||||
short_description: Edit XFCE4 Configurations
|
||||
description:
|
||||
- This module allows for the manipulation of Xfce 4 Configuration with the help of
|
||||
xfconf-query. Please see the xfconf-query(1) man page for more details.
|
||||
- This module allows for the manipulation of Xfce 4 Configuration with the help of xfconf-query. Please see the xfconf-query(1) man page for more
|
||||
details.
|
||||
seealso:
|
||||
- name: xfconf-query(1) man page
|
||||
- name: xfconf-query(1) man page
|
||||
description: Manual page of the C(xfconf-query) tool at the XFCE documentation site.
|
||||
link: 'https://docs.xfce.org/xfce/xfconf/xfconf-query'
|
||||
|
||||
- name: xfconf - Configuration Storage System
|
||||
- name: xfconf - Configuration Storage System
|
||||
description: XFCE documentation for the Xfconf configuration system.
|
||||
link: 'https://docs.xfce.org/xfce/xfconf/start'
|
||||
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
- community.general.attributes
|
||||
|
||||
attributes:
|
||||
check_mode:
|
||||
|
|
@ -38,44 +39,38 @@ attributes:
|
|||
options:
|
||||
channel:
|
||||
description:
|
||||
- A Xfconf preference channel is a top-level tree key, inside of the
|
||||
Xfconf repository that corresponds to the location for which all
|
||||
application properties/keys are stored. See man xfconf-query(1).
|
||||
- A Xfconf preference channel is a top-level tree key, inside of the Xfconf repository that corresponds to the location for which all application
|
||||
properties/keys are stored. See man xfconf-query(1).
|
||||
required: true
|
||||
type: str
|
||||
property:
|
||||
description:
|
||||
- A Xfce preference key is an element in the Xfconf repository
|
||||
that corresponds to an application preference. See man xfconf-query(1).
|
||||
- A Xfce preference key is an element in the Xfconf repository that corresponds to an application preference. See man xfconf-query(1).
|
||||
required: true
|
||||
type: str
|
||||
value:
|
||||
description:
|
||||
- Preference properties typically have simple values such as strings,
|
||||
integers, or lists of strings and integers. See man xfconf-query(1).
|
||||
- Preference properties typically have simple values such as strings, integers, or lists of strings and integers. See man xfconf-query(1).
|
||||
type: list
|
||||
elements: raw
|
||||
value_type:
|
||||
description:
|
||||
- The type of value being set.
|
||||
- When providing more than one O(value_type), the length of the list must
|
||||
be equal to the length of O(value).
|
||||
- If only one O(value_type) is provided, but O(value) contains more than
|
||||
on element, that O(value_type) will be applied to all elements of O(value).
|
||||
- If the O(property) being set is an array and it can possibly have only one
|
||||
element in the array, then O(force_array=true) must be used to ensure
|
||||
that C(xfconf-query) will interpret the value as an array rather than a
|
||||
scalar.
|
||||
- When providing more than one O(value_type), the length of the list must be equal to the length of O(value).
|
||||
- If only one O(value_type) is provided, but O(value) contains more than on element, that O(value_type) will be applied to all elements of
|
||||
O(value).
|
||||
- If the O(property) being set is an array and it can possibly have only one element in the array, then O(force_array=true) must be used to
|
||||
ensure that C(xfconf-query) will interpret the value as an array rather than a scalar.
|
||||
- Support for V(uchar), V(char), V(uint64), and V(int64) has been added in community.general 4.8.0.
|
||||
type: list
|
||||
elements: str
|
||||
choices: [ string, int, double, bool, uint, uchar, char, uint64, int64, float ]
|
||||
choices: [string, int, double, bool, uint, uchar, char, uint64, int64, float]
|
||||
state:
|
||||
type: str
|
||||
description:
|
||||
- The action to take upon the property/value.
|
||||
- The state V(get) has been removed in community.general 5.0.0. Please use the module M(community.general.xfconf_info) instead.
|
||||
choices: [ present, absent ]
|
||||
choices: [present, absent]
|
||||
default: "present"
|
||||
force_array:
|
||||
description:
|
||||
|
|
@ -84,9 +79,10 @@ options:
|
|||
default: false
|
||||
aliases: ['array']
|
||||
version_added: 1.0.0
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
---
|
||||
- name: Change the DPI to "192"
|
||||
xfconf:
|
||||
channel: "xsettings"
|
||||
|
|
@ -110,42 +106,40 @@ EXAMPLES = """
|
|||
force_array: true
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
channel:
|
||||
RETURN = """
|
||||
---
|
||||
channel:
|
||||
description: The channel specified in the module parameters
|
||||
returned: success
|
||||
type: str
|
||||
sample: "xsettings"
|
||||
property:
|
||||
property:
|
||||
description: The property specified in the module parameters
|
||||
returned: success
|
||||
type: str
|
||||
sample: "/Xft/DPI"
|
||||
value_type:
|
||||
value_type:
|
||||
description:
|
||||
- The type of the value that was changed (V(none) for O(state=reset)).
|
||||
Either a single string value or a list of strings for array types.
|
||||
- The type of the value that was changed (V(none) for O(state=reset)). Either a single string value or a list of strings for array types.
|
||||
- This is a string or a list of strings.
|
||||
returned: success
|
||||
type: any
|
||||
sample: '"int" or ["str", "str", "str"]'
|
||||
value:
|
||||
value:
|
||||
description:
|
||||
- The value of the preference key after executing the module. Either a
|
||||
single string value or a list of strings for array types.
|
||||
- The value of the preference key after executing the module. Either a single string value or a list of strings for array types.
|
||||
- This is a string or a list of strings.
|
||||
returned: success
|
||||
type: any
|
||||
sample: '"192" or ["orange", "yellow", "violet"]'
|
||||
previous_value:
|
||||
previous_value:
|
||||
description:
|
||||
- The value of the preference key before executing the module.
|
||||
Either a single string value or a list of strings for array types.
|
||||
- The value of the preference key before executing the module. Either a single string value or a list of strings for array types.
|
||||
- This is a string or a list of strings.
|
||||
returned: success
|
||||
type: any
|
||||
sample: '"96" or ["red", "blue", "green"]'
|
||||
cmd:
|
||||
cmd:
|
||||
description:
|
||||
- A list with the resulting C(xfconf-query) command executed by the module.
|
||||
returned: success
|
||||
|
|
@ -163,7 +157,7 @@ RETURN = '''
|
|||
- string
|
||||
- --set
|
||||
- Pacific/Auckland
|
||||
'''
|
||||
"""
|
||||
|
||||
from ansible_collections.community.general.plugins.module_utils.module_helper import StateModuleHelper
|
||||
from ansible_collections.community.general.plugins.module_utils.xfconf import xfconf_runner
|
||||
|
|
|
|||
|
|
@ -7,17 +7,18 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
DOCUMENTATION = """
|
||||
---
|
||||
module: xfconf_info
|
||||
author:
|
||||
- "Alexei Znamensky (@russoz)"
|
||||
- "Alexei Znamensky (@russoz)"
|
||||
short_description: Retrieve XFCE4 configurations
|
||||
version_added: 3.5.0
|
||||
description:
|
||||
- This module allows retrieving Xfce 4 configurations with the help of C(xfconf-query).
|
||||
- This module allows retrieving Xfce 4 configurations with the help of C(xfconf-query).
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
- community.general.attributes.info_module
|
||||
- community.general.attributes
|
||||
- community.general.attributes.info_module
|
||||
attributes:
|
||||
check_mode:
|
||||
version_added: 3.3.0
|
||||
|
|
@ -40,10 +41,11 @@ options:
|
|||
- If not provided and a O(channel) is provided, then the module will list all available properties in that O(channel).
|
||||
type: str
|
||||
notes:
|
||||
- See man xfconf-query(1) for more details.
|
||||
'''
|
||||
- See man xfconf-query(1) for more details.
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
---
|
||||
- name: Get list of all available channels
|
||||
community.general.xfconf_info: {}
|
||||
register: result
|
||||
|
|
@ -66,8 +68,9 @@ EXAMPLES = """
|
|||
register: result
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
channels:
|
||||
RETURN = """
|
||||
---
|
||||
channels:
|
||||
description:
|
||||
- List of available channels.
|
||||
- Returned when the module receives no parameter at all.
|
||||
|
|
@ -79,7 +82,7 @@ RETURN = '''
|
|||
- displays
|
||||
- xsettings
|
||||
- xfwm4
|
||||
properties:
|
||||
properties:
|
||||
description:
|
||||
- List of available properties for a specific channel.
|
||||
- Returned by passing only the O(channel) parameter to the module.
|
||||
|
|
@ -101,18 +104,18 @@ RETURN = '''
|
|||
- /Xft/Hinting
|
||||
- /Xft/HintStyle
|
||||
- /Xft/RGBA
|
||||
is_array:
|
||||
is_array:
|
||||
description:
|
||||
- Flag indicating whether the property is an array or not.
|
||||
returned: success
|
||||
type: bool
|
||||
value:
|
||||
value:
|
||||
description:
|
||||
- The value of the property. Empty if the property is of array type.
|
||||
returned: success
|
||||
type: str
|
||||
sample: Monospace 10
|
||||
value_array:
|
||||
value_array:
|
||||
description:
|
||||
- The array value of the property. Empty if the property is not of array type.
|
||||
returned: success
|
||||
|
|
@ -122,7 +125,7 @@ RETURN = '''
|
|||
- Main
|
||||
- Work
|
||||
- Tmp
|
||||
'''
|
||||
"""
|
||||
|
||||
from ansible_collections.community.general.plugins.module_utils.module_helper import ModuleHelper
|
||||
from ansible_collections.community.general.plugins.module_utils.xfconf import xfconf_runner
|
||||
|
|
|
|||
Loading…
Reference in New Issue