Generate documentation for prepare/feature plugins

.gitignore

@@ -9,6 +9,7 @@ docs/plugins/finish.rst
 docs/plugins/prepare.rst
 docs/plugins/provision.rst
 docs/plugins/report.rst
+docs/plugins/prepare-feature.rst
 docs/plugins/test-checks.rst
 docs/plugins/hardware-matrix.rst
 docs/guide/test-runner-guest-compatibility-matrix.inc.rst

docs/Makefile

@@ -27,7 +27,7 @@ GENERATED_DIRECTORIES = spec stories
 STEPS = discover provision prepare execute finish report
 
 # A list of `plugins/*.rst` files to generate
-PLUGIN_TARGETS = $(addsuffix .rst,$(addprefix plugins/,$(STEPS))) plugins/test-checks.rst
+PLUGIN_TARGETS = $(addsuffix .rst,$(addprefix plugins/,$(STEPS))) plugins/prepare-feature.rst plugins/test-checks.rst
 
 .DEFAULT_GOAL := help
 
@@ -64,6 +64,11 @@ define plugins-dependencies =
 $(SCRIPTSDIR)/generate-plugins.py $(PLUGINS_TEMPLATE) $(TMTDIR)/steps/__init__.py $(TMTDIR)/steps/$(call plugins-to-step,$@)/*.py
 endef
 
+# Render a list of dependencies of a `plugins/feature.rst` target
+define plugins-feature-dependencies =
+$(SCRIPTSDIR)/generate-plugins.py $(PLUGINS_TEMPLATE) $(TMTDIR)/steps/__init__.py $(TMTDIR)/steps/prepare/__init__.py $(TMTDIR)/steps/prepare/feature/*.py
+endef
+
 # Render a list of dependencies of a `plugins/test-checks.rst` target
 define plugins-checks-dependencies =
 $(SCRIPTSDIR)/generate-plugins.py $(PLUGINS_TEMPLATE) $(TMTDIR)/steps/__init__.py $(TMTDIR)/checks/*.py
@@ -97,6 +102,9 @@ plugins/provision.rst: $(call plugins-dependencies)
 plugins/report.rst: $(call plugins-dependencies)
 	$(call build-plugins)
 
+plugins/prepare-feature.rst: $(call plugins-feature-dependencies)
+	$(call build-plugins)
+
 plugins/test-checks.rst: $(call plugins-checks-dependencies)
 	$(call build-plugins)
 

docs/plugins/index.rst

@@ -22,4 +22,5 @@ Here you will find documentation for plugins shipped with tmt.
     Execute <execute>
     Finish <finish>
     Report <report>
+    prepare/feature <prepare-feature>
     Test Checks <test-checks>

docs/plugins/prepare-header.inc.rst

@@ -0,0 +1,7 @@
+prepare/feature plugins
+-----------------------
+
+Features available via :ref:`prepare/feature</plugins/prepare/feature>`
+plugin are implemented and shipped as plugins. See
+:ref:`/plugins/prepare-feature` for the list of available feature
+plugins and their configuration.

docs/scripts/generate-plugins.py

@@ -14,6 +14,7 @@
 import tmt.steps.execute
 import tmt.steps.finish
 import tmt.steps.prepare
+import tmt.steps.prepare.feature
 import tmt.steps.provision
 import tmt.steps.report
 import tmt.utils
@@ -125,6 +126,21 @@ def plugin_iterator():
     return plugin_iterator
 
 
+def _create_feature_plugin_iterator(
+        registry: tmt.plugins.PluginRegistry[tmt.steps.prepare.feature.FeatureClass]):
+    """ Create iterator over plugins of a feature plugin registry """
+
+    def plugin_iterator():
+        for plugin_id in registry.iter_plugin_ids():
+            plugin = registry.get_plugin(plugin_id)
+
+            # TODO: once data class becomes composed from plugin data
+            # classes, the main one is all we have.
+            yield plugin_id, plugin, tmt.steps.prepare.feature.PrepareFeature._data_class
+
+    return plugin_iterator
+
+
 def _create_test_check_plugin_iterator(registry: tmt.plugins.PluginRegistry[tmt.steps.Method]):
     """ Create iterator over plugins of a test check registry """
 
@@ -178,6 +194,10 @@ def main() -> None:
         plugin_generator = _create_step_plugin_iterator(
             tmt.steps.report.ReportPlugin._supported_methods)
 
+    elif step_name == 'prepare-feature':
+        plugin_generator = _create_feature_plugin_iterator(
+            tmt.steps.prepare.feature._FEATURE_PLUGIN_REGISTRY)
+
     elif step_name == 'test-checks':
         plugin_generator = _create_test_check_plugin_iterator(tmt.checks._CHECK_PLUGIN_REGISTRY)
 

docs/templates/plugins.rst.j2

@@ -45,7 +45,7 @@
 
 .. _/plugins/{{ STEP }}:
 
-{{ STEP | replace('-', ' ') | capitalize }} Plugins
+{% if STEP == 'prepare-feature' %}prepare/feature{% else %}{{ STEP | replace('-', ' ') | capitalize }}{% endif %} Plugins
 {{ '~' * (8 + (STEP | length)) }}
 
 .. include:: {{ STEP }}-header.inc.rst

tmt/steps/prepare/feature/__init__.py

@@ -147,6 +147,9 @@ class PrepareFeature(tmt.steps.prepare.PreparePlugin[PrepareFeatureData]):
         prepare:
             how: feature
             epel: disabled
+
+    See :ref:`/plugins/prepare-feature` for the list of available
+    feature plugins and their configuration.
     """
 
     _data_class = PrepareFeatureData