fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! Add a directives for general purpose documentation in downstream projects

swrichards · swrichards · commit d992deaf86a8 · 2025-02-04T09:59:25.000+01:00
diff --git a/docs/config_docs.rst b/docs/config_docs.rst
@@ -97,3 +97,8 @@ For example, to hide the usage section, show the steps without autodoc:
         :show_command_usage: false
         :show_steps_autodoc: false
 
+
+.. note::
+
+    The titles for the step sections will be taken from the step's ``verbose_title`` field,
+    whereas the descriptions are taken from the step class's docstring (if present).
