2 Commits (dc5f83c09bafc39ecf396411370c8fad9d046f51)

Author	SHA1	Message	Date
Adrian Likins	89c973445c	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 6e34ea6242 and a3afc78535 * 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>`	7 years ago
Adrian Likins	28b9dc4bed	Vault docs (#26979) ... * start rst docs for ansible-vault encrypt_string * wip, vault format docs (sorta markdown ish atm) * wip - formatting * wip, vault docs * Fix refs to other docs for now fixing default_role in conf.py will remove need for this * add 'ref' to cli names * more vault docs * wip, misc fixes * add some encrypt_string examples * Fix up rstcheck warnings The code blocks in question included the output that would be echo'ed from running the command, which isnt valid bash. * fix formatting and rstcheck warnings about code-block * Add envvar ref for ANSIBLE_VAULT_PASSWORD_FILE * fix doc title * Fixed title underline	7 years ago