move examples to user-guide

cta-observatory · Sep 8, 2023 · 743ee40 · 743ee40
1 parent c6662cd
commit 743ee40
Show file tree

Hide file tree

Showing 27 changed files with 24 additions and 22 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -15,15 +15,18 @@ help:
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile examples
+%: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-examples:
-	mkdir -p user-guide/examples
-
 clean:
 	rm -rf api
-	rm -rf user-guide/examples
+	rm -rf user-guide/examples/*.zip
+	rm -rf user-guide/examples/*.rst
+	rm -rf user-guide/examples/*/*.ipynb
+	rm -rf user-guide/examples/*/*.py.md5
+	rm -rf user-guide/examples/*/*.pickle
+	rm -rf user-guide/examples/*/*.rst
+	rm -rf user-guide/examples/*/images
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -150,22 +150,22 @@ def setup(app):
 
 sphinx_gallery_conf = {
     "examples_dirs": [
-        "../examples/examples",
+        "user-guide/examples",
     ],  # path to your example scripts
     "gallery_dirs": [
         "user-guide/examples",
     ],  # path to where to save gallery generated output
     "subsection_order": ExplicitOrder(
         [
-            "../examples/examples/algorithms",
-            "../examples/examples/core",
-            "../examples/examples/visualization",
-            "../examples/examples/tutorials",
+            "user-guide/examples/tutorials",
+            "user-guide/examples/algorithms",
+            "user-guide/examples/core",
+            "user-guide/examples/visualization",
         ]
     ),
     "within_subsection_order": FileNameSortKey,
     "nested_sections": False,
-    "copyfile_regex": r"index.rst|.*\.png|.*\.json",
+    # "copyfile_regex": r".*\.rst|.*\.png|.*\.json",
     "filename_pattern": r".*\.py",
     "promote_jupyter_magic": True,
     "line_numbers": True,
@@ -229,8 +229,7 @@ def setup(app):
     "changes",
     "user-guide/examples/*/*.ipynb",
     "user-guide/examples/*/*.py",
-    "user-guide/tutorials/*.ipynb",
-    "user-guide/tutorials/*.py",
+    "user-guide/examples/*/README.rst",
 ]
 
 # The name of the Pygments (syntax highlighting) style to use.
@@ -245,7 +244,7 @@ def setup(app):
 # Define the json_url for our version switcher.
 json_url = "https://ctapipe.readthedocs.io/en/latest/_static/switcher.json"
 
-# Define the version we use for matching in the version switcher.
+# Define the version we use for matching in the version switcher.,
 version_match = os.getenv("READTHEDOCS_VERSION")
 # If READTHEDOCS_VERSION doesn't exist, we're not on RTD
 # If it is an integer, we're in a PR build and the version isn't correct.

diff --git a/docs/user-guide/examples/README.txt b/docs/user-guide/examples/README.txt
@@ -0,0 +1,6 @@
+.. _tutorials_and_examples_gallery:
+
+Tutorials and Examples gallery
+==============================
+
+This gallery provides an overview of different ctapipe modules and how to use them.
diff --git a/examples/examples/algorithms/README.rst → ...user-guide/examples/algorithms/README.txt b/examples/examples/algorithms/README.rst → ...user-guide/examples/algorithms/README.txt
diff --git a/...amples/algorithms/convert_images_to_2d.py → ...amples/algorithms/convert_images_to_2d.py b/...amples/algorithms/convert_images_to_2d.py → ...amples/algorithms/convert_images_to_2d.py
diff --git a/examples/examples/algorithms/dilate_image.py → ...guide/examples/algorithms/dilate_image.py b/examples/examples/algorithms/dilate_image.py → ...guide/examples/algorithms/dilate_image.py
diff --git a/...s/examples/algorithms/nd_interpolation.py → ...e/examples/algorithms/nd_interpolation.py b/...s/examples/algorithms/nd_interpolation.py → ...e/examples/algorithms/nd_interpolation.py
diff --git a/...es/examples/core/InstrumentDescription.py → ...de/examples/core/InstrumentDescription.py b/...es/examples/core/InstrumentDescription.py → ...de/examples/core/InstrumentDescription.py
diff --git a/examples/examples/core/README.rst → docs/user-guide/examples/core/README.txt b/examples/examples/core/README.rst → docs/user-guide/examples/core/README.txt
diff --git a/examples/examples/core/command_line_tools.py → ...guide/examples/core/command_line_tools.py b/examples/examples/core/command_line_tools.py → ...guide/examples/core/command_line_tools.py
diff --git a/examples/examples/core/config.json → docs/user-guide/examples/core/config.json b/examples/examples/core/config.json → docs/user-guide/examples/core/config.json
diff --git a/examples/examples/core/containers.py → docs/user-guide/examples/core/containers.py b/examples/examples/core/containers.py → docs/user-guide/examples/core/containers.py
diff --git a/examples/examples/core/provenance.py → docs/user-guide/examples/core/provenance.py b/examples/examples/core/provenance.py → docs/user-guide/examples/core/provenance.py
diff --git a/...ples/examples/core/table_writer_reader.py → ...uide/examples/core/table_writer_reader.py b/...ples/examples/core/table_writer_reader.py → ...uide/examples/core/table_writer_reader.py
diff --git a/examples/examples/tutorials/README.rst → .../user-guide/examples/tutorials/README.txt b/examples/examples/tutorials/README.rst → .../user-guide/examples/tutorials/README.txt
@@ -1,6 +1,6 @@
-.. _tutorials_gallery:
+.. _tutorials:
 
-Tutorials gallery
+Tutorials
 =================
 
 This gallery contains different tutorials of different use cases for ctapipe.
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/...les/examples/tutorials/ctapipe_handson.py → ...ide/examples/tutorials/ctapipe_handson.py b/...les/examples/tutorials/ctapipe_handson.py → ...ide/examples/tutorials/ctapipe_handson.py
diff --git a/...es/examples/tutorials/ctapipe_overview.py → ...de/examples/tutorials/ctapipe_overview.py b/...es/examples/tutorials/ctapipe_overview.py → ...de/examples/tutorials/ctapipe_overview.py
diff --git a/examples/examples/tutorials/ground_frame.png → ...guide/examples/tutorials/ground_frame.png b/examples/examples/tutorials/ground_frame.png → ...guide/examples/tutorials/ground_frame.png
diff --git a/...xamples/tutorials/raw_data_exploration.py → ...xamples/tutorials/raw_data_exploration.py b/...xamples/tutorials/raw_data_exploration.py → ...xamples/tutorials/raw_data_exploration.py
diff --git a/examples/examples/tutorials/theta_square.py → ...-guide/examples/tutorials/theta_square.py b/examples/examples/tutorials/theta_square.py → ...-guide/examples/tutorials/theta_square.py
diff --git a/...xamples/tutorials/tilted_ground_frame.png → ...xamples/tutorials/tilted_ground_frame.png b/...xamples/tutorials/tilted_ground_frame.png → ...xamples/tutorials/tilted_ground_frame.png
diff --git a/examples/examples/visualization/README.rst → ...r-guide/examples/visualization/README.txt b/examples/examples/visualization/README.rst → ...r-guide/examples/visualization/README.txt
diff --git a/...s/examples/visualization/array_display.py → ...e/examples/visualization/array_display.py b/...s/examples/visualization/array_display.py → ...e/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/examples/examples/README.txt b/examples/examples/README.txt