Add redundant option in conf.py to guide contributors

probabl-ai · Feb 14, 2025 · 9237788 · 9237788
1 parent eaec39a
commit 9237788
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/sphinx/conf.py b/sphinx/conf.py
@@ -85,6 +85,7 @@ def reset_mpl(gallery_conf, fname):
 sphinx_gallery_conf = {
     "examples_dirs": "../examples",  # path to example scripts
     "gallery_dirs": "auto_examples",  # path to gallery generated output
+    "filename_pattern": "plot_",  # pattern to select examples; change this to only build some of the examples
     "subsection_order": ExplicitOrder(subsections_order),  # sorting gallery subsections
     # see https://sphinx-gallery.github.io/stable/configuration.html#sub-gallery-order
     "within_subsection_order": "ExampleTitleSortKey",  # See https://sphinx-gallery.github.io/stable/configuration.html#sorting-gallery-examples for alternatives