community.general/docs/docsite/rst/command_line_tools.rst at 18582295e315e5648dcc947baa14db28da6bbc8c - ansible/community.general - git.l3d.ch

ansible/community.general

mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

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

15 lines

231 B

ReStructuredText

Raw Blame History

 Command Line Tools
 ==================
 .. toctree:: :maxdepth: 1
     ansible
     ansible-playbook
     ansible-vault
     ansible-galaxy
     ansible-console
     ansible-config
     ansible-doc
     ansible-inventory
     ansible-pull