ansible

Commit Graph

Author	SHA1	Message	Date
jborean93	b92452f775	fix for make webdocs (cherry picked from commit `0e22afef52`)	7 years ago
Adrian Likins	51949fdeec	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>` (cherry picked from commit `89c973445c`)	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
Toshio Kuratomi	40ea448c7b	Misc docs fixes * Revise and link inline to the lists of modules * Fix jinja2 objects.inv fallback path * Fix bolding of deprecation marker * Change module_support to link to lists via :doc: That links to the top of the page instead of a section. * Add a short text for each list of maintained modules * Change maintenance info to only display on core and network modules	7 years ago
Adrian Likins	2941e86671	Fix plugin_formatter.py -l / MODULES=none make webdocs Fix the get_module_info check against the limit_to_modules list so building a subset/none of the module docs works again.	7 years ago
Toshio Kuratomi	546187a8af	Revamp the plugin_formatter doc generator * Use a template to generate the category lists * Refactor so that we first extract all of the data that we need to build the docs and then give that data to the templates to build with * Add docs page listing modules ordered by support level	7 years ago
Toshio Kuratomi	af2073d057	metadata 1.1 * Add network value to support_by field. * New support_by value, certified * Deprecate curated in favor of certified * Add conversion from 1.0 to 1.1 to metadata-tool * Add supported by Red Hat field to ansible-doc output	7 years ago
Branko Majic	f78baa1300	Implement ability to limit module documentation building (#24576 ) * Implement ability to limit module documentation building: - Added new option to plugin_formatter.py to support passing-in a list of modules for which the documentation should be built. - Updated docuemtnation Makefile to allow specifying list of modules via environment variables (defaulting to all modules). - Update instructions for building documentation and module development to include commands and description of limiting module documentation builds. * Updated implementation for limiting module documentation building: - Pass list of modules (or None) to list_modules function instead of string. - Move conversion of module list to argument parsing code. - No special keywords. Default ("") means build all modules. For no modules just specify non-existing module name. - Updated documentation to reflect the changes. * Updated implementation for limiting module documentation building: - Use better default value, and don't treat "" as special case. - Conditionally invoke different variants of command in Makefile instead of using special value "". * Minor edits Wording tweak	7 years ago
Matt Clay	789218c215	Initial ansible-test sanity docs. (#26775 ) * Rename no-iterkeys test for consistency. * Require docs for all ansible-test sanity tests. * Initial ansible-test sanity docs. * Fix capitalization of Python. * Fix sanity code smell test false positives. * Fix another code-smell false positive.	7 years ago
Abhijeet Kasurde	b89cb95609	Fix spelling mistakes (comments only) (#25564 ) Original Author : klemens <ka7@github.com> Taking over previous PR as per https://github.com/ansible/ansible/pull/23644#issuecomment-307334525 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>	8 years ago
Dag Wieers	47738eb1dd	docs: PEP8 compliance (#24681 ) - Make PEP8 compliant	8 years ago
Matt Martz	eb5e906014	Support py3 in plugin_formatter.py (#24384 ) * Support py3 in plugin_formatter.py * Do everything in bytes	8 years ago
Toshio Kuratomi	0249918c7b	When outputting text to a file, convert to bytes first. Fixes #23137	8 years ago
Brian Coca	2a2e02aea4	.--. . .--. ---.. / .. ... / .- -. -. --- -.-- .. -. --.	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	424e1946f4	moved docs generation and templates to docs/	8 years ago

16 Commits (34ceed635dc5462f2228f1a2591072c66d49177e)