dd45caa7a9
* Remove straight.plugin dependency (#80084) (cherry picked from commitf587856beb) * Update package-data sanity test (#80344) The test no longer relies on the Makefile. (cherry picked from commit46362bbd27) * Remove obsolete release bits (#80347) Releases are now built using the `packaging/release.py` tool. This makes the `Makefile` and associated files in `packaging/release/` and `packaging/sdist/` obsolete. * Use --no-isolation for package-data sanity test (#80377) The dependencies are already in the sanity test venv. This avoids use of unpinned dependencies and a dependency on a network connection. (cherry picked from commit7fcb9960e6) * Set the minimum setuptools to 45.2.0 (#80649) Also update the package-data sanity test to use the minimum setuptools version. (cherry picked from commit4d25e3d54f) * Use package_data instead of include_package_data (#80652) This resolves warnings generated by setuptools such as the following: _Warning: Package 'ansible.galaxy.data' is absent from the `packages` configuration. (cherry picked from commit5ac292e12d) * Fix os.walk issues in package-data sanity test (#80703) * Remove `docs` and `examples` directories (#81011) * Remove docs dir * Updates to reflect docs removal * Fix integration test * Remove examples dir * Updates to reflect examples removal * Remove build_library and build-ansible.py * Remove refs to build_library and build-ansible.py * Remove obsolete template * Remove obsolete template reference * Remove the now obsolete rstcheck sanity test (cherry picked from commit72e038e823) * Omit pre-built man pages from sdist (#81395) Since man pages aren't accessible to users after a `pip install`, there's no need to include them in the sdist. This change makes it trivial to build man pages from source, which makes them much easier to iterate on. It also simplifies creation and testing of the sdist, since it no longer requires building man pages. The new `packaging/cli-doc/build.py` script can generate both man pages and RST documentation. This supports inclusion on the docs site without a dependency on `ansible-core` internals. Having a single implementation for both simplifies keeping the two formats in sync. (cherry picked from commit691c8e8603)
140 lines
3.5 KiB
Django/Jinja
140 lines
3.5 KiB
Django/Jinja
{% macro render_action(parent, action, action_docs) -%}
|
|
**{{ parent + action }}**
|
|
{{ (action_docs['desc']|default(' ')) |replace('\n', ' ')}}
|
|
|
|
{% if action_docs['options'] %}
|
|
{% for option in action_docs['options']|sort(attribute='options') %}
|
|
{% for switch in option['options'] if switch in action_docs['option_names'] %} **{{switch}}**{% if option['arg'] %} '{{option['arg']}}'{% endif %}{% if not loop.last %}, {% endif %}{% endfor %}
|
|
|
|
{{ (option['desc']) }}
|
|
{% endfor %}
|
|
{% endif %}
|
|
|
|
{% set nested_actions = action_docs['actions'] %}
|
|
{% if nested_actions %}
|
|
{% for nested_action in nested_actions %}
|
|
{{ render_action(parent + action + ' ', nested_action, nested_actions[nested_action]) }}
|
|
{% endfor %}
|
|
{% endif %}
|
|
|
|
{%- endmacro %}
|
|
|
|
{{ cli_name }}
|
|
{{ '=' * ( cli_name|length|int ) }}
|
|
|
|
{{ '-' * ( short_desc|default('')|string|length|int ) }}
|
|
{{short_desc|default('')}}
|
|
{{ '-' * ( short_desc|default('')|string|length|int ) }}
|
|
|
|
:Version: Ansible {{ version }}
|
|
:Manual section: 1
|
|
:Manual group: System administration commands
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
--------
|
|
{{ usage|replace('%prog', cli_name) }}
|
|
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
{{ long_desc|default('', True)|wordwrap }}
|
|
|
|
{% if options %}
|
|
COMMON OPTIONS
|
|
--------------
|
|
{% for option in options|sort(attribute='options') %}
|
|
{% for switch in option['options'] %}**{{switch}}**{% if option['arg'] %} '{{option['arg']}}'{% endif %}{% if not loop.last %}, {% endif %}{% endfor %}
|
|
|
|
{{ option['desc'] }}
|
|
{% endfor %}
|
|
{% endif %}
|
|
|
|
{% if arguments %}
|
|
ARGUMENTS
|
|
---------
|
|
|
|
{% for arg in arguments %}
|
|
{{ arg }}
|
|
|
|
{{ (arguments[arg]|default(' '))|wordwrap }}
|
|
|
|
{% endfor %}
|
|
{% endif %}
|
|
|
|
{% if actions %}
|
|
ACTIONS
|
|
-------
|
|
{% for action in actions %}
|
|
{{ render_action('', action, actions[action]) }}
|
|
{% endfor %}
|
|
{% endif %}
|
|
|
|
|
|
{% if inventory %}
|
|
INVENTORY
|
|
---------
|
|
|
|
Ansible stores the hosts it can potentially operate on in an inventory.
|
|
This can be an YAML file, ini-like file, a script, directory, list, etc.
|
|
For additional options, see the documentation on https://docs.ansible.com/.
|
|
|
|
{% endif %}
|
|
ENVIRONMENT
|
|
-----------
|
|
|
|
The following environment variables may be specified.
|
|
|
|
{% if inventory %}
|
|
ANSIBLE_INVENTORY -- Override the default ansible inventory sources
|
|
|
|
{% endif %}
|
|
{% if library %}
|
|
ANSIBLE_LIBRARY -- Override the default ansible module library path
|
|
|
|
{% endif %}
|
|
ANSIBLE_CONFIG -- Specify override location for the ansible config file
|
|
|
|
Many more are available for most options in ansible.cfg
|
|
|
|
For a full list check https://docs.ansible.com/. or use the `ansible-config` command.
|
|
|
|
FILES
|
|
-----
|
|
|
|
{% if inventory %}
|
|
/etc/ansible/hosts -- Default inventory file
|
|
|
|
{% endif %}
|
|
/etc/ansible/ansible.cfg -- Config file, used if present
|
|
|
|
~/.ansible.cfg -- User config file, overrides the default config if present
|
|
|
|
./ansible.cfg -- Local config file (in current working directory) assumed to be 'project specific' and overrides the rest if present.
|
|
|
|
As mentioned above, the ANSIBLE_CONFIG environment variable will override all others.
|
|
|
|
AUTHOR
|
|
------
|
|
|
|
Ansible was originally written by Michael DeHaan.
|
|
|
|
|
|
COPYRIGHT
|
|
---------
|
|
|
|
Copyright © 2018 Red Hat, Inc | Ansible.
|
|
Ansible is released under the terms of the GPLv3 license.
|
|
|
|
|
|
SEE ALSO
|
|
--------
|
|
|
|
{% for other in cli_bin_name_list|sort %}{% if other != cli_name %}**{{ other }}** (1){% if not loop.last %}, {% endif %}{% endif %}{% endfor %}
|
|
|
|
Extensive documentation is available in the documentation site:
|
|
<https://docs.ansible.com>.
|
|
IRC and mailing list info can be found in file CONTRIBUTING.md,
|
|
available in: <https://github.com/ansible/ansible>
|