Move examples back out of docs tree

This interfered with doctests collection, running the examples during the collection, which, since they are not modules but scripts, blocked it. Also added git and sphinx build dirs to pytest ignore directories.
cta-observatory · Sep 11, 2023 · 6fb72e8 · 6fb72e8
1 parent 1c56a3e
commit 6fb72e8
Show file tree

Hide file tree

Showing 30 changed files with 13 additions and 8 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,3 @@
-
 .pytest_cache
 *.log
 
@@ -27,6 +26,7 @@ MANIFEST
 # Sphinx
 docs/api
 docs/_build
+docs/auto_examples
 
 # Editors and IDEs
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -150,14 +150,14 @@ def setup(app):
 
 sphinx_gallery_conf = {
     "examples_dirs": [
-        "user-guide/examples",
+        "../examples",
     ],  # path to your example scripts
     "subsection_order": ExplicitOrder(
         [
-            "user-guide/examples/tutorials",
-            "user-guide/examples/algorithms",
-            "user-guide/examples/core",
-            "user-guide/examples/visualization",
+            "../examples/tutorials",
+            "../examples/algorithms",
+            "../examples/core",
+            "../examples/visualization",
         ]
     ),
     "within_subsection_order": FileNameSortKey,

diff --git a/docs/user-guide/examples/index.rst b/docs/user-guide/examples/index.rst
diff --git a/docs/user-guide/examples_tutorials.rst b/docs/user-guide/examples_tutorials.rst
@@ -0,0 +1 @@
+.. include:: ../auto_examples/index.rst
diff --git a/docs/user-guide/index.rst b/docs/user-guide/index.rst
@@ -9,5 +9,5 @@ User Guide
    getting-started
    tools
    data_models/index
-   examples/index
+   examples_tutorials
    FAQ
diff --git a/docs/user-guide/examples/README.rst → examples/README.rst b/docs/user-guide/examples/README.rst → examples/README.rst
diff --git a/...user-guide/examples/algorithms/README.rst → examples/algorithms/README.rst b/...user-guide/examples/algorithms/README.rst → examples/algorithms/README.rst
diff --git a/...amples/algorithms/convert_images_to_2d.py → examples/algorithms/convert_images_to_2d.py b/...amples/algorithms/convert_images_to_2d.py → examples/algorithms/convert_images_to_2d.py
diff --git a/...guide/examples/algorithms/dilate_image.py → examples/algorithms/dilate_image.py b/...guide/examples/algorithms/dilate_image.py → examples/algorithms/dilate_image.py
diff --git a/...e/examples/algorithms/nd_interpolation.py → examples/algorithms/nd_interpolation.py b/...e/examples/algorithms/nd_interpolation.py → examples/algorithms/nd_interpolation.py
diff --git a/...de/examples/core/InstrumentDescription.py → examples/core/InstrumentDescription.py b/...de/examples/core/InstrumentDescription.py → examples/core/InstrumentDescription.py
diff --git a/docs/user-guide/examples/core/README.rst → examples/core/README.rst b/docs/user-guide/examples/core/README.rst → examples/core/README.rst
diff --git a/...guide/examples/core/command_line_tools.py → examples/core/command_line_tools.py b/...guide/examples/core/command_line_tools.py → examples/core/command_line_tools.py
diff --git a/docs/user-guide/examples/core/config.json → examples/core/config.json b/docs/user-guide/examples/core/config.json → examples/core/config.json
diff --git a/docs/user-guide/examples/core/containers.py → examples/core/containers.py b/docs/user-guide/examples/core/containers.py → examples/core/containers.py
diff --git a/docs/user-guide/examples/core/provenance.py → examples/core/provenance.py b/docs/user-guide/examples/core/provenance.py → examples/core/provenance.py
diff --git a/...uide/examples/core/table_writer_reader.py → examples/core/table_writer_reader.py b/...uide/examples/core/table_writer_reader.py → examples/core/table_writer_reader.py
diff --git a/.../user-guide/examples/tutorials/README.rst → examples/tutorials/README.rst b/.../user-guide/examples/tutorials/README.rst → examples/tutorials/README.rst
diff --git a/.../tutorials/calibrated_data_exploration.py → .../tutorials/calibrated_data_exploration.py b/.../tutorials/calibrated_data_exploration.py → .../tutorials/calibrated_data_exploration.py
diff --git a/...examples/tutorials/coordinates_example.py → examples/tutorials/coordinates_example.py b/...examples/tutorials/coordinates_example.py → examples/tutorials/coordinates_example.py
diff --git a/...ide/examples/tutorials/ctapipe_handson.py → examples/tutorials/ctapipe_handson.py b/...ide/examples/tutorials/ctapipe_handson.py → examples/tutorials/ctapipe_handson.py
diff --git a/...de/examples/tutorials/ctapipe_overview.py → examples/tutorials/ctapipe_overview.py b/...de/examples/tutorials/ctapipe_overview.py → examples/tutorials/ctapipe_overview.py
diff --git a/...guide/examples/tutorials/ground_frame.png → examples/tutorials/ground_frame.png b/...guide/examples/tutorials/ground_frame.png → examples/tutorials/ground_frame.png
diff --git a/...xamples/tutorials/raw_data_exploration.py → examples/tutorials/raw_data_exploration.py b/...xamples/tutorials/raw_data_exploration.py → examples/tutorials/raw_data_exploration.py
diff --git a/...-guide/examples/tutorials/theta_square.py → examples/tutorials/theta_square.py b/...-guide/examples/tutorials/theta_square.py → examples/tutorials/theta_square.py
diff --git a/...xamples/tutorials/tilted_ground_frame.png → examples/tutorials/tilted_ground_frame.png b/...xamples/tutorials/tilted_ground_frame.png → examples/tutorials/tilted_ground_frame.png
diff --git a/...r-guide/examples/visualization/README.rst → examples/visualization/README.rst b/...r-guide/examples/visualization/README.rst → examples/visualization/README.rst
diff --git a/...e/examples/visualization/array_display.py → examples/visualization/array_display.py b/...e/examples/visualization/array_display.py → examples/visualization/array_display.py
diff --git a/.../examples/visualization/camera_display.py → examples/visualization/camera_display.py b/.../examples/visualization/camera_display.py → examples/visualization/camera_display.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -28,6 +28,11 @@ filterwarnings = [
     "error::astropy.utils.exceptions.AstropyDeprecationWarning",
     "error::ctapipe.utils.deprecation.CTAPipeDeprecationWarning",
 ]
+norecursedirs = [
+    ".git",
+    "_build",
+    "auto_examples",
+]
 
 [tool.towncrier]
     package = "ctapipe"