1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/lib/ansible
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>`
2017-09-07 15:44:20 -04:00
..
cli generate rst doc pages for command line tools (#27530) 2017-09-07 15:44:20 -04:00
compat Remove wildcard imports 2017-07-28 22:10:17 -07:00
config config: use path list for default inventory 2017-09-07 00:09:07 -04:00
errors Ansible Config part2 (#27448) 2017-08-15 16:38:59 -04:00
executor removed warning that was appearing in every run 2017-08-31 16:26:49 -04:00
galaxy Removes container-enabled warning (#27578) 2017-08-01 12:51:03 -04:00
inventory bypass get_hosts and use dictionary directly 2017-08-30 10:56:45 -04:00
module_utils shared argument spec for FreeIPA (#28950) 2017-09-07 21:07:15 +02:00
modules shared argument spec for FreeIPA (#28950) 2017-09-07 21:07:15 +02:00
parsing Fixes #22335: Adds filename extension to tempfile for Vault 2017-08-28 11:01:04 -04:00
playbook less confusing 'args' message (#29053) 2017-09-06 18:20:06 -04:00
plugins Combine exception handling to simplify code (#29096) 2017-09-07 13:20:44 -04:00
template Ansible Config part2 (#27448) 2017-08-15 16:38:59 -04:00
utils shared argument spec for FreeIPA (#28950) 2017-09-07 21:07:15 +02:00
vars fix for getting vars and hostvars without specifying the host 2017-09-05 11:14:00 -04:00
__init__.py Fix ziploader for the cornercase of ansible invoking ansible. 2016-04-29 08:47:49 -07:00
constants.py Ansible Config part2 (#27448) 2017-08-15 16:38:59 -04:00
release.py Bump the versions now that devel is 2.5 2017-09-06 13:13:57 -07:00