Try "Handle motion/drift" documentation as a sphinx gallery

.gitignore

@@ -180,6 +180,7 @@ examples/tutorials/*.svg
 doc/_build/*
 doc/tutorials/*
 doc/sources/*
+*sg_execution_times.rst
 
 examples/getting_started/tmp_*
 examples/getting_started/phy

doc/conf.py

@@ -119,7 +119,7 @@
 sphinx_gallery_conf = {
     'only_warn_on_example_error': True,
     'examples_dirs': ['../examples/tutorials'],
-    'gallery_dirs': ['tutorials' ],  # path where to save gallery generated examples
+    'gallery_dirs': ['tutorials'],  # path where to save gallery generated examples
     'subsection_order': ExplicitOrder([
                                        '../examples/tutorials/core',
                                        '../examples/tutorials/extractors',
@@ -130,9 +130,19 @@
     'within_subsection_order': FileNameSortKey,
     'ignore_pattern': '/generate_',
     'nested_sections': False,
-    'copyfile_regex': r'.*\.rst|.*\.png|.*\.svg'
+    'copyfile_regex': r'.*\.rst|.*\.png|.*\.svg',
+    'filename_pattern': '/plot_',
 }
 
+if tags.has("handle_drift") or tags.has("all_long_plot"):
+
+    if (handle_drift_path := (Path('long_tutorials/handle_drift'))).is_dir():
+        shutil.rmtree(handle_drift_path)
+
+    sphinx_gallery_conf['examples_dirs'].append('../examples/long_tutorials/handle_drift')
+    sphinx_gallery_conf["gallery_dirs"].append(handle_drift_path.as_posix())
+
+
 intersphinx_mapping = {
     "neo": ("https://neo.readthedocs.io/en/latest/", None),
     "probeinterface": ("https://probeinterface.readthedocs.io/en/stable/", None),

doc/how_to/index.rst

@@ -13,3 +13,4 @@ Guides on how to solve specific, short problems in SpikeInterface. Learn how to.
     combine_recordings
     process_by_channel_group
     load_your_data_into_sorting
+    /long_tutorials/handle_drift/plot_handle_drift.rst

doc/long_tutorials/handle_drift/index.rst

@@ -0,0 +1,72 @@
+:orphan:
+
+Handle Drift Tutorial
+---------------------
+
+This tutorial is not mean to be displayed on
+a sphinx gallery. The generated index.rst is not
+meant to be linked to in any toctree.
+
+Instead, sphinx-gallery is used to
+automatically build this page, which
+takes a long time (~25 minutes), and it is
+linked too manually, directly to the
+rst (TODO: fill in filename) that
+sphinx-gallery generates.
+
+
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbnails">
+
+.. thumbnail-parent-div-open
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbcontainer" tooltip="Probe movement is an inevitability when running in vivo electrophysiology recordings. Motion, c...">
+
+.. only:: html
+
+  .. image:: /long_tutorials/handle_drift/images/thumb/sphx_glr_plot_handle_drift_thumb.png
+    :alt:
+
+  :ref:`sphx_glr_long_tutorials_handle_drift_plot_handle_drift.py`
+
+.. raw:: html
+
+      <div class="sphx-glr-thumbnail-title">Handle probe drift with spikeinterface NEW</div>
+    </div>
+
+
+.. thumbnail-parent-div-close
+
+.. raw:: html
+
+    </div>
+
+
+.. toctree::
+   :hidden:
+
+   /long_tutorials/handle_drift/plot_handle_drift
+
+
+.. only:: html
+
+  .. container:: sphx-glr-footer sphx-glr-footer-gallery
+
+    .. container:: sphx-glr-download sphx-glr-download-python
+
+      :download:`Download all examples in Python source code: handle_drift_python.zip </long_tutorials/handle_drift/handle_drift_python.zip>`
+
+    .. container:: sphx-glr-download sphx-glr-download-jupyter
+
+      :download:`Download all examples in Jupyter notebooks: handle_drift_jupyter.zip </long_tutorials/handle_drift/handle_drift_jupyter.zip>`
+
+
+.. only:: html
+
+ .. rst-class:: sphx-glr-signature
+
+    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_