Adds line about filtering auto_modules to docs (#974)

Adds line about filtering auto_modules to docs --------- Co-authored-by: Jeff Ohrstrom <[email protected]>
OSC · Nov 20, 2024 · 30686b1 · 30686b1
1 parent 01b8de6
commit 30686b1
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/source/how-tos/app-development/interactive/form.rst b/source/how-tos/app-development/interactive/form.rst
@@ -235,6 +235,25 @@ auto_modules_<MODULE>
      attributes:
        auto_modules_matlab:
          default: false
+
+  To filter versions that show up in the drop-down list, you can use a Ruby regex (https://rubular.com/)
+  (without the wrapping `//`) or a string:
+
+  Regex:
+
+  .. code-block:: yaml
+
+    attributes:
+      auto_modules_matlab:
+        filter: (intel|gnu)\d*
+
+  String:
+
+  .. code-block:: yaml
+    
+    attributes:
+      auto_modules_matlab:
+        filter: intel
   
   See :ref:`the module directory configuration <module_file_dir>` on how to enable
   the cluster module files that need to be read.