ansible/docs/docsite/rst/command_line_tools.rst

Command Line Tools
==================


.. toctree:: :maxdepth: 1

    ansible
    ansible-playbook
    ansible-vault
    ansible-galaxy
    ansible-console
    ansible-config
    ansible-doc
    ansible-inventory
    ansible-pull
generate rst doc pages for command line tools (#27530) * let generate_man also gen rst pages for cli tools * make template-file, output-dir, output format cli options for generate_man * update main Makefile to use generate_man.py for docs (man pages and rst) * update vault docs that use :option: * Edits based on https://github.com/alikins/ansible/commit/6e34ea62429c417939bd96b6de5bf7e6ab1ff765 and https://github.com/alikins/ansible/commit/a3afc785357878da354e21a709cf3b9f16c3f146 * add a optparse 'desc' to lib/ansible/cli/config.py The man page needs a short desc for the 'NAME' field which it gets from the option parse 'desc' value. Fixes building ansible-config man page. * add trim_docstring from pep257 to generate_man use pep258 docstring trim function to fix up any indention weirdness inherit to doc strings (ie, lines other than first line being indented. * Add refs to cli command actions To reference ansible-vaults --vault-id option, use: :option:`The link text here <ansible-vault --vault-id>` or: :option:`--vault-id <ansible-vault --vault-id>` To reference ansible-vault's 'encrypt' action, use: :ref:`The link text here <ansible_vault_encrypt>` or most of the time: :ref:`ansible-vault encrypt <ansible_vault_encrypt>` (cherry picked from commit 89c973445c6bbb08551703917a4eec6e484a3e0c) 2017-09-07 19:44:20 +00:00			`Command Line Tools`
			`==================`


			`.. toctree:: :maxdepth: 1`

			`ansible`
			`ansible-playbook`
			`ansible-vault`
			`ansible-galaxy`
			`ansible-console`
			`ansible-config`
			`ansible-doc`
			`ansible-inventory`
			`ansible-pull`