mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-04 23:39:09 -07:00
Use semantic markup (modules d-g) (#6672)
* Use semantic markup. * 'ignore:' is no longer needed. * E() now works better.
This commit is contained in:
parent
6fc1df9b83
commit
2ed82e0318
34 changed files with 307 additions and 306 deletions
|
@ -14,7 +14,7 @@ DOCUMENTATION = '''
|
|||
module: easy_install
|
||||
short_description: Installs Python libraries
|
||||
description:
|
||||
- Installs Python libraries, optionally in a I(virtualenv)
|
||||
- Installs Python libraries, optionally in a C(virtualenv)
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
|
@ -26,13 +26,13 @@ options:
|
|||
name:
|
||||
type: str
|
||||
description:
|
||||
- A Python library name
|
||||
- A Python library name.
|
||||
required: true
|
||||
virtualenv:
|
||||
type: str
|
||||
description:
|
||||
- an optional I(virtualenv) directory path to install into. If the
|
||||
I(virtualenv) does not exist, it is created automatically
|
||||
- An optional O(virtualenv) directory path to install into. If the
|
||||
O(virtualenv) does not exist, it is created automatically.
|
||||
virtualenv_site_packages:
|
||||
description:
|
||||
- Whether the virtual environment will inherit packages from the
|
||||
|
@ -46,21 +46,21 @@ options:
|
|||
type: str
|
||||
description:
|
||||
- The command to create the virtual environment with. For example
|
||||
C(pyvenv), C(virtualenv), C(virtualenv2).
|
||||
V(pyvenv), V(virtualenv), V(virtualenv2).
|
||||
default: virtualenv
|
||||
executable:
|
||||
type: str
|
||||
description:
|
||||
- The explicit executable or a pathname to the executable to be used to
|
||||
run easy_install for a specific version of Python installed in the
|
||||
system. For example C(easy_install-3.3), if there are both Python 2.7
|
||||
system. For example V(easy_install-3.3), if there are both Python 2.7
|
||||
and 3.3 installations in the system and you want to run easy_install
|
||||
for the Python 3.3 installation.
|
||||
default: easy_install
|
||||
state:
|
||||
type: str
|
||||
description:
|
||||
- The desired state of the library. C(latest) ensures that the latest version is installed.
|
||||
- The desired state of the library. V(latest) ensures that the latest version is installed.
|
||||
choices: [present, latest]
|
||||
default: present
|
||||
notes:
|
||||
|
@ -68,8 +68,8 @@ notes:
|
|||
libraries. Thus this module is not able to remove libraries. It is
|
||||
generally recommended to use the M(ansible.builtin.pip) module which you can first install
|
||||
using M(community.general.easy_install).
|
||||
- Also note that I(virtualenv) must be installed on the remote host if the
|
||||
C(virtualenv) parameter is specified.
|
||||
- Also note that C(virtualenv) must be installed on the remote host if the
|
||||
O(virtualenv) parameter is specified.
|
||||
requirements: [ "virtualenv" ]
|
||||
author: "Matt Wright (@mattupstate)"
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue