ansible

Commit Graph

Author	SHA1	Message	Date
Brendan Good	475844d1ae	Fix man page template typo. (#48585 ) changed from 'direcotry' to 'directory'.	6 years ago
Brian Coca	b6f2aad600	ignore ansible.cfg in world writable cwd (#42070 ) * ignore ansible.cfg in world writable cwd * also added 'warnings' to config * updated man page template	6 years ago
Matt Clay	c262dbfd30	Use https for links to ansible.com domains.	7 years ago
Matt Martz	a89d0d0919	Ensure that arguments for sub commands are properly indented (#37992 )	7 years ago
Joseph Herlant	00a7ff7974	Move man pages generations to rst2man (#37861 )	7 years ago
Matt Martz	349099a4c6	Fix sorting in man template on python3. Fixes #33663 (#33673 )	7 years ago
Brian Coca	b233f3f296	updated plugin docs (#30490 ) * updated docs - for devs: - added inventory/vars section - made some updates to general section and other plugin types - for users: - added 'user' plugin section to start describing the plugins - docs on types, what they are and how to use - removed ref to deleted AUTHORS file - corrected several typos/headers - added descriptions to config.rst template - ignore generated files for cli/plugins and config - remove new generated files on `make clean` - moved details from devguid and intro doc to plugin specific pages - pretied up lookup notes - changed precedence ref to not conflict config - removed duplicate config data, as config is autogenerated and up to date - put new plugins under playbooks - added `pass` cause rst/python dislikes fractions - removed dupe in .gitignore, alpha sorted to avoid moar dupes - added try cause rst/python freaks out * generate plugins into their own dir only do plugins that support docs use toctree from main plugins page	7 years ago
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
Brian Coca	a0a26700c9	remove author as it dupes	8 years ago
Brian Coca	da045a9c1f	more info for asciidoc to correctly build manpages	8 years ago
Brian Coca	18a7a1ec31	added docs to CLI docstringsadded removed 'now intermediate build files' from repo adjusted gitignore	8 years ago
Brian Coca	b4c47ebf68	draft to generate man pages	8 years ago

12 Commits (11862782fff0ef530d44523676b82dfdf596dfea)