Add sphinx gallery

examples/tests/test_examples.py

@@ -24,20 +24,34 @@
 
 
 # run all tests unless they opt-out
-examples_to_run = find_examples(
-    negative_query="# run_example = false", return_stems=True
-)
+examples_to_run_dict = {
+    path.stem: path for path in find_examples(negative_query="# run_example = false")
+}
+examples_to_run = [x for x in examples_to_run_dict.keys()]
 
 # only test output of examples that opt-in
-examples_to_test = find_examples(query="# test_example = true", return_stems=True)
+examples_to_test_dict = {
+    path.stem: path for path in find_examples(query="# test_example = true")
+}
+examples_to_test = [x for x in examples_to_test_dict.keys()]
 
 
 @pytest.mark.parametrize("module", examples_to_run)
 def test_examples_run(module, force_offscreen, disable_call_later_after_run):
     """Run every example marked to see if they can run without error."""
     # use runpy so the module is not actually imported (and can be gc'd)
     # but also to be able to run the code in the __main__ block
-    runpy.run_module(f"examples.{module}", run_name="__main__")
+
+    # (relative) module name from project root
+    module_name = (
+        examples_to_run_dict[module]
+        .relative_to(ROOT)
+        .with_suffix("")
+        .as_posix()
+        .replace("/", ".")
+    )
+
+    runpy.run_module(module_name, run_name="__main__")
 
 
 @pytest.fixture
@@ -101,8 +115,25 @@ def test_examples_screenshots(
 ):
     """Run every example marked for testing."""
 
-    # render
-    example = importlib.import_module(f"examples.validation.{module}")
+    # (relative) module name from project root
+    module_name = (
+        examples_to_test_dict[module]
+        .relative_to(ROOT)
+        .with_suffix("")
+        .as_posix()
+        .replace("/", ".")
+    )
+
+    # import the example module
+    example = importlib.import_module(module_name)
+
+    # ensure it is unloaded after the test
+    def unload_module():
+        del sys.modules[module_name]
+
+    request.addfinalizer(unload_module)
+
+    # render a frame
     img = example.renderer.target.draw()
 
     # check if _something_ was rendered