ansible

Commit Graph

Author	SHA1	Message	Date
Brian Coca	5220f30244	decelerate docs!	7 years ago
Adrian Likins	da15cf1f54	Generate plugin rst (#28901 ) Generate rst docs for plugins Based on rst generated for modules. But generated plugin docs go into docs/docsite/rst/plugins/$PLUGIN_TYPE/plugin_name.rst ( docs/docsite/rst/plugins/connection/ssh.py for ex) * move plugins docs to rst/_plugins/ subdirs for namespace Only gen support pages for modules for now. * Add generated plugin docs to gitignore* add list__plugins templates support MODULES/PLUGINS filters for make htmldocs Add a 'PLUGINS=ssh' filter env var like MODULES to filter plugins to build docs for. * fixup 'historical' version_added, skip plugins/loader.py * Fix plugins_by_support ref link to new plugins// location use :ref: for common_return_values, allow empty version_added * warnings on missing doc info * add a prefix to _random_choice It was colliding with the target for random_choice plugin	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
Scott Butler	a9f82f8a8a	Fixed incorrect version numbers.	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
Adrian Likins	8035e68d44	Generate a rst for config and env options from base.yml (#28739 ) * wip, gen docs from config/base.yml * wip * dont change conf.py here * cleanup, add dump_config --template-file cli opt * some desc are string, some are lists... TODO: fix base.yml so it is consistent * Filter out TODO and empty descriptions	7 years ago
John R Barker	df58d943d3	Docs porting guides 2.0 & 2.3 (#27632 ) * Create new "Porting Guide" section Create new landing page Add porting_guide_2.3 * correct CHANGELOG * Document blocks * Document named blocks * OpenBSD & async action plugins * OpenBSD & async action plugins * versioadded for name * review comments	7 years ago
David Moreau-Simard	e2d874c744	Improve release and development cycle documentation This commit: - Adds a table highlighting the status of each version and provides a link to each major release's changelog - Re-inforces how stable versions are maintained and for how long - Moves this documentation out of the developer tree (this is interesting for users too!) while keeping a link there.	7 years ago
Brian Coca	57f8b791d6	consolidated docs point to new doc locations removed non existing dirs	8 years ago

9 Commits (5c3bbd4620c4a94ece7741ecfe5514a1bd06422b)