mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-04-24 04:39:15 +00:00
4fa82b9617
* Make all doc fragments private. * Make all plugin utils private. * Make all module utils private. * Reformat. * Changelog fragment. * Update configs and ignores. * Adjust unit test names.
42 lines
2 KiB
Python
42 lines
2 KiB
Python
# Copyright (c) 2024, Alexei Znamensky <russoz@gmail.com>
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
# Note that this doc fragment is **PRIVATE** to the collection. It can have breaking changes at any time.
|
|
# Do not use this from other collections or standalone plugins/modules!
|
|
|
|
from __future__ import annotations
|
|
|
|
|
|
class ModuleDocFragment:
|
|
DOCUMENTATION = r"""
|
|
options:
|
|
global:
|
|
description:
|
|
- The module passes the C(--global) argument to C(pipx), to execute actions in global scope.
|
|
type: bool
|
|
default: false
|
|
executable:
|
|
description:
|
|
- Path to the C(pipx) installed in the system.
|
|
- If not specified, the module uses C(python -m pipx) to run the tool, using the same Python interpreter as ansible
|
|
itself.
|
|
type: path
|
|
requirements:
|
|
- This module requires C(pipx) version 1.7.0 or above.
|
|
- Please note that C(pipx) 1.7.0 requires Python 3.8 or above.
|
|
- Please note that C(pipx) 1.8.0 requires Python 3.9 or above.
|
|
notes:
|
|
- This module does not install the C(pipx) python package, however that can be easily done with the module M(ansible.builtin.pip).
|
|
- This module does not require C(pipx) to be in the shell C(PATH), but it must be loadable by Python as a module, meaning
|
|
that C(python -m pipx) must work.
|
|
- This module honors C(pipx) environment variables such as but not limited to E(PIPX_HOME) and E(PIPX_BIN_DIR) passed using
|
|
the R(environment Ansible keyword, playbooks_environment).
|
|
- This module disabled emojis in the output of C(pipx) commands to reduce clutter. In C(pipx) 1.8.0, the environment variable
|
|
E(USE_EMOJI) was renamed to E(PIPX_USE_EMOJI) and for compatibility with both versions, starting in community.general
|
|
11.4.0, this module sets them both to C(0) to disable emojis.
|
|
seealso:
|
|
- name: C(pipx) command manual page
|
|
description: Manual page for the command.
|
|
link: https://pipx.pypa.io/latest/docs/
|
|
"""
|