mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-06 21:32:49 +00:00
centralize doc/config plugin lists (#38775)
* centralize doc/config plugin lists also update list for generation in docsite added note to ensure they are in sync * updated shell page to list plugins added some more docs hinting at plugins being configurable * fix edit link for plugins
This commit is contained in:
@@ -72,8 +72,7 @@ class DocCLI(CLI):
|
||||
help='**For internal testing only** Show documentation for all plugins.')
|
||||
self.parser.add_option("-t", "--type", action="store", default='module', dest='type', type='choice',
|
||||
help='Choose which plugin type (defaults to "module")',
|
||||
choices=['cache', 'callback', 'connection', 'inventory', 'lookup', 'module', 'shell', 'strategy', 'vars'])
|
||||
|
||||
choices=C.DOCUMENTABLE_PLUGINS)
|
||||
super(DocCLI, self).parse()
|
||||
|
||||
if [self.options.all_plugins, self.options.list_dir, self.options.list_files, self.options.show_snippet].count(True) > 1:
|
||||
|
||||
@@ -91,6 +91,10 @@ DEFAULT_SUDO_PASS = None
|
||||
DEFAULT_REMOTE_PASS = None
|
||||
DEFAULT_SUBSET = None
|
||||
DEFAULT_SU_PASS = None
|
||||
# FIXME: expand to other plugins, but never doc fragments
|
||||
CONFIGURABLE_PLUGINS = ('cache', 'callback', 'connection', 'inventory', 'lookup', 'shell')
|
||||
# NOTE: always update the docs/docsite/Makefile to match
|
||||
DOCUMENTABLE_PLUGINS = CONFIGURABLE_PLUGINS + ('module', 'strategy', 'vars')
|
||||
IGNORE_FILES = ("COPYING", "CONTRIBUTING", "LICENSE", "README", "VERSION", "GUIDELINES") # ignore during module search
|
||||
INTERNAL_RESULT_KEYS = ('add_host', 'add_group')
|
||||
LOCALHOST = ('127.0.0.1', 'localhost', '::1')
|
||||
|
||||
@@ -209,9 +209,8 @@ class PluginLoader:
|
||||
if self.class_name:
|
||||
type_name = get_plugin_class(self.class_name)
|
||||
|
||||
# FIXME: expand to other plugins, but never doc fragments
|
||||
# if type name != 'module_doc_fragment':
|
||||
if type_name in ('callback', 'connection', 'inventory', 'lookup', 'shell'):
|
||||
if type_name in C.CONFIGURABLE_PLUGINS:
|
||||
dstring = get_docstring(path, fragment_loader, verbose=False, ignore_errors=True)[0]
|
||||
|
||||
if dstring and 'options' in dstring and isinstance(dstring['options'], dict):
|
||||
|
||||
Reference in New Issue
Block a user