ansible

Commit Graph

Author	SHA1	Message	Date
Brian Coca	afc460c943	tollerate 'string' descriptions	9 years ago
Ed Santiago	47fb002c88	(minor) fix broken link, awkward phrasing (#32085 ) * (minor) fix broken link, awkward phrasing Simple transposition error was resulting in a link not being properly htmlified. Also clean up redundant 'this' and trailing whitespace. Signed-off-by: Ed Santiago <santiago@redhat.com> * Edits	9 years ago
Brian Coca	2ed46e04f4	more updates to plugin/config generation (#30787 ) * fixed module generation added missing lookup page point to plugins when plugins made modules singular add display for verbose an debug messages nicer templating, changed generation order for ref corrected links moved most of lookup docs to plugin section * Copy edits * Fixed typos * Clarified wording	9 years ago
sduthil	15dffe04dd	fix misformatted docsite link (#31384 ) reason: The link is showing verbatim in the docs, where it should only show "knowledge base article". Also, generating the docs shows a lot of: docs/docsite/rst/win_acl_module.rst:424: WARNING: Unknown target name: "know ledge base article<https://access.redhat.com/articles/rhel-top-support-policies>".	9 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	9 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	9 years ago
Jiri Tyr	5660b18b6a	Adding missing period into the module doc template	9 years ago
Andreas Maier	b900f4a3be	Fixed return table in module docs generated by plugin_formatter.py (#25329 ) (#25330 ) This change fixes two issues with the generated return table: 1. When specifying a list of strings in the 'description' field of a return value, it shows them in Python list syntax on the resulting web page, e.g. `['a', 'b', 'c']`. 2. When specifying more than one line for the 'sample' field, the result table gets damaged in the HTML output. In addition, this change re-arranges the HTML tags produced in the generated RST file such that they line up nicely and can better be checked by humans for completeness. Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>	9 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	9 years ago
John R Barker	f338dd2fc3	Render returned dictionaries Fixes #24775 (#24777 ) plugin.rst.j2 was out of sync with syntax validator	9 years ago
John R Barker	ecbf8e933a	Docs how to test (2nd) (#24094 ) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail	9 years ago
Brian Coca	424e1946f4	moved docs generation and templates to docs/	9 years ago

12 Commits (2995439fbfa2bb0f260adced9baca064dcce9eb0)