flatten structure

cta-observatory · Sep 8, 2023 · 23136dc · 23136dc
1 parent 1753542
commit 23136dc
Show file tree

Hide file tree

Showing 13 changed files with 14 additions and 18 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -15,17 +15,15 @@ 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 tutorials
+%: Makefile examples
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 examples:
-	mkdir user-guide/examples
-
-tutorials:
-	mkdir user-guide/tutorials
+	mkdir -p user-guide/examples
 
 clean:
 	rm -rf api
+	rm -rf user-guide/examples
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -144,16 +144,24 @@ def setup(app):
 ]
 
 # Sphinx gallery config
+from sphinx_gallery.sorting import ExplicitOrder, FileNameSortKey
 sphinx_gallery_conf = {
     "examples_dirs": [
         "../examples/examples",
-        "../examples/tutorials",
     ],  # path to your example scripts
     "gallery_dirs": [
         "user-guide/examples",
-        "user-guide/tutorials",
     ],  # path to where to save gallery generated output
-    "nested_sections": True,
+    'subsection_order': ExplicitOrder(
+        [
+            '../examples/examples/algorithms',
+            '../examples/examples/core',
+            '../examples/examples/visualization',
+            '../examples/examples/tutorials'
+        ]
+    ),
+    "within_subsection_order": FileNameSortKey,
+    "nested_sections": False,
     "copyfile_regex": r"index.rst|.*\.png|.*\.json",
     "filename_pattern": r".*\.py",
     "promote_jupyter_magic": True,

diff --git a/docs/user-guide/index.rst b/docs/user-guide/index.rst
@@ -9,6 +9,5 @@ User Guide
    getting-started
    tools
    data_models/index
-   tutorials/index
    examples/index
    FAQ
diff --git a/examples/examples/index.rst b/examples/examples/index.rst
diff --git a/examples/tutorials/README.txt → examples/examples/tutorials/README.rst b/examples/tutorials/README.txt → examples/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/examples/tutorials/ctapipe_handson.py → ...les/examples/tutorials/ctapipe_handson.py b/examples/tutorials/ctapipe_handson.py → ...les/examples/tutorials/ctapipe_handson.py
diff --git a/examples/tutorials/ctapipe_overview.py → ...es/examples/tutorials/ctapipe_overview.py b/examples/tutorials/ctapipe_overview.py → ...es/examples/tutorials/ctapipe_overview.py
diff --git a/examples/tutorials/ground_frame.png → examples/examples/tutorials/ground_frame.png b/examples/tutorials/ground_frame.png → examples/examples/tutorials/ground_frame.png
diff --git a/examples/tutorials/raw_data_exploration.py → ...xamples/tutorials/raw_data_exploration.py b/examples/tutorials/raw_data_exploration.py → ...xamples/tutorials/raw_data_exploration.py
diff --git a/examples/tutorials/theta_square.py → examples/examples/tutorials/theta_square.py b/examples/tutorials/theta_square.py → examples/examples/tutorials/theta_square.py
diff --git a/examples/tutorials/tilted_ground_frame.png → ...xamples/tutorials/tilted_ground_frame.png b/examples/tutorials/tilted_ground_frame.png → ...xamples/tutorials/tilted_ground_frame.png