From d0af02a0c4b47547abaee1b24dde1e9e2ce6f989 Mon Sep 17 00:00:00 2001 From: Maximilian Linhoff Date: Mon, 11 Sep 2023 14:08:52 +0200 Subject: [PATCH] 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. --- docs/conf.py | 10 +++++----- {docs/user-guide/examples => examples}/README.rst | 0 .../examples => examples}/algorithms/README.rst | 0 .../algorithms/convert_images_to_2d.py | 0 .../algorithms/dilate_image.py | 0 .../algorithms/nd_interpolation.py | 0 .../core/InstrumentDescription.py | 0 .../examples => examples}/core/README.rst | 0 .../core/command_line_tools.py | 0 .../examples => examples}/core/config.json | 0 .../examples => examples}/core/containers.py | 0 .../examples => examples}/core/provenance.py | 0 .../core/table_writer_reader.py | 0 {docs/user-guide/examples => examples}/index.rst | 0 .../examples => examples}/tutorials/README.rst | 0 .../tutorials/calibrated_data_exploration.py | 0 .../tutorials/coordinates_example.py | 0 .../tutorials/ctapipe_handson.py | 0 .../tutorials/ctapipe_overview.py | 0 .../tutorials/ground_frame.png | Bin .../tutorials/raw_data_exploration.py | 0 .../examples => examples}/tutorials/theta_square.py | 0 .../tutorials/tilted_ground_frame.png | Bin .../examples => examples}/visualization/README.rst | 0 .../visualization/array_display.py | 0 .../visualization/camera_display.py | 0 pyproject.toml | 5 +++++ 27 files changed, 10 insertions(+), 5 deletions(-) rename {docs/user-guide/examples => examples}/README.rst (100%) rename {docs/user-guide/examples => examples}/algorithms/README.rst (100%) rename {docs/user-guide/examples => examples}/algorithms/convert_images_to_2d.py (100%) rename {docs/user-guide/examples => examples}/algorithms/dilate_image.py (100%) rename {docs/user-guide/examples => examples}/algorithms/nd_interpolation.py (100%) rename {docs/user-guide/examples => examples}/core/InstrumentDescription.py (100%) rename {docs/user-guide/examples => examples}/core/README.rst (100%) rename {docs/user-guide/examples => examples}/core/command_line_tools.py (100%) rename {docs/user-guide/examples => examples}/core/config.json (100%) rename {docs/user-guide/examples => examples}/core/containers.py (100%) rename {docs/user-guide/examples => examples}/core/provenance.py (100%) rename {docs/user-guide/examples => examples}/core/table_writer_reader.py (100%) rename {docs/user-guide/examples => examples}/index.rst (100%) rename {docs/user-guide/examples => examples}/tutorials/README.rst (100%) rename {docs/user-guide/examples => examples}/tutorials/calibrated_data_exploration.py (100%) rename {docs/user-guide/examples => examples}/tutorials/coordinates_example.py (100%) rename {docs/user-guide/examples => examples}/tutorials/ctapipe_handson.py (100%) rename {docs/user-guide/examples => examples}/tutorials/ctapipe_overview.py (100%) rename {docs/user-guide/examples => examples}/tutorials/ground_frame.png (100%) rename {docs/user-guide/examples => examples}/tutorials/raw_data_exploration.py (100%) rename {docs/user-guide/examples => examples}/tutorials/theta_square.py (100%) rename {docs/user-guide/examples => examples}/tutorials/tilted_ground_frame.png (100%) rename {docs/user-guide/examples => examples}/visualization/README.rst (100%) rename {docs/user-guide/examples => examples}/visualization/array_display.py (100%) rename {docs/user-guide/examples => examples}/visualization/camera_display.py (100%) diff --git a/docs/conf.py b/docs/conf.py index 4554ca94ab4..29d5cdee0c5 100644 --- 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/README.rst b/examples/README.rst similarity index 100% rename from docs/user-guide/examples/README.rst rename to examples/README.rst diff --git a/docs/user-guide/examples/algorithms/README.rst b/examples/algorithms/README.rst similarity index 100% rename from docs/user-guide/examples/algorithms/README.rst rename to examples/algorithms/README.rst diff --git a/docs/user-guide/examples/algorithms/convert_images_to_2d.py b/examples/algorithms/convert_images_to_2d.py similarity index 100% rename from docs/user-guide/examples/algorithms/convert_images_to_2d.py rename to examples/algorithms/convert_images_to_2d.py diff --git a/docs/user-guide/examples/algorithms/dilate_image.py b/examples/algorithms/dilate_image.py similarity index 100% rename from docs/user-guide/examples/algorithms/dilate_image.py rename to examples/algorithms/dilate_image.py diff --git a/docs/user-guide/examples/algorithms/nd_interpolation.py b/examples/algorithms/nd_interpolation.py similarity index 100% rename from docs/user-guide/examples/algorithms/nd_interpolation.py rename to examples/algorithms/nd_interpolation.py diff --git a/docs/user-guide/examples/core/InstrumentDescription.py b/examples/core/InstrumentDescription.py similarity index 100% rename from docs/user-guide/examples/core/InstrumentDescription.py rename to examples/core/InstrumentDescription.py diff --git a/docs/user-guide/examples/core/README.rst b/examples/core/README.rst similarity index 100% rename from docs/user-guide/examples/core/README.rst rename to examples/core/README.rst diff --git a/docs/user-guide/examples/core/command_line_tools.py b/examples/core/command_line_tools.py similarity index 100% rename from docs/user-guide/examples/core/command_line_tools.py rename to examples/core/command_line_tools.py diff --git a/docs/user-guide/examples/core/config.json b/examples/core/config.json similarity index 100% rename from docs/user-guide/examples/core/config.json rename to examples/core/config.json diff --git a/docs/user-guide/examples/core/containers.py b/examples/core/containers.py similarity index 100% rename from docs/user-guide/examples/core/containers.py rename to examples/core/containers.py diff --git a/docs/user-guide/examples/core/provenance.py b/examples/core/provenance.py similarity index 100% rename from docs/user-guide/examples/core/provenance.py rename to examples/core/provenance.py diff --git a/docs/user-guide/examples/core/table_writer_reader.py b/examples/core/table_writer_reader.py similarity index 100% rename from docs/user-guide/examples/core/table_writer_reader.py rename to examples/core/table_writer_reader.py diff --git a/docs/user-guide/examples/index.rst b/examples/index.rst similarity index 100% rename from docs/user-guide/examples/index.rst rename to examples/index.rst diff --git a/docs/user-guide/examples/tutorials/README.rst b/examples/tutorials/README.rst similarity index 100% rename from docs/user-guide/examples/tutorials/README.rst rename to examples/tutorials/README.rst diff --git a/docs/user-guide/examples/tutorials/calibrated_data_exploration.py b/examples/tutorials/calibrated_data_exploration.py similarity index 100% rename from docs/user-guide/examples/tutorials/calibrated_data_exploration.py rename to examples/tutorials/calibrated_data_exploration.py diff --git a/docs/user-guide/examples/tutorials/coordinates_example.py b/examples/tutorials/coordinates_example.py similarity index 100% rename from docs/user-guide/examples/tutorials/coordinates_example.py rename to examples/tutorials/coordinates_example.py diff --git a/docs/user-guide/examples/tutorials/ctapipe_handson.py b/examples/tutorials/ctapipe_handson.py similarity index 100% rename from docs/user-guide/examples/tutorials/ctapipe_handson.py rename to examples/tutorials/ctapipe_handson.py diff --git a/docs/user-guide/examples/tutorials/ctapipe_overview.py b/examples/tutorials/ctapipe_overview.py similarity index 100% rename from docs/user-guide/examples/tutorials/ctapipe_overview.py rename to examples/tutorials/ctapipe_overview.py diff --git a/docs/user-guide/examples/tutorials/ground_frame.png b/examples/tutorials/ground_frame.png similarity index 100% rename from docs/user-guide/examples/tutorials/ground_frame.png rename to examples/tutorials/ground_frame.png diff --git a/docs/user-guide/examples/tutorials/raw_data_exploration.py b/examples/tutorials/raw_data_exploration.py similarity index 100% rename from docs/user-guide/examples/tutorials/raw_data_exploration.py rename to examples/tutorials/raw_data_exploration.py diff --git a/docs/user-guide/examples/tutorials/theta_square.py b/examples/tutorials/theta_square.py similarity index 100% rename from docs/user-guide/examples/tutorials/theta_square.py rename to examples/tutorials/theta_square.py diff --git a/docs/user-guide/examples/tutorials/tilted_ground_frame.png b/examples/tutorials/tilted_ground_frame.png similarity index 100% rename from docs/user-guide/examples/tutorials/tilted_ground_frame.png rename to examples/tutorials/tilted_ground_frame.png diff --git a/docs/user-guide/examples/visualization/README.rst b/examples/visualization/README.rst similarity index 100% rename from docs/user-guide/examples/visualization/README.rst rename to examples/visualization/README.rst diff --git a/docs/user-guide/examples/visualization/array_display.py b/examples/visualization/array_display.py similarity index 100% rename from docs/user-guide/examples/visualization/array_display.py rename to examples/visualization/array_display.py diff --git a/docs/user-guide/examples/visualization/camera_display.py b/examples/visualization/camera_display.py similarity index 100% rename from docs/user-guide/examples/visualization/camera_display.py rename to examples/visualization/camera_display.py diff --git a/pyproject.toml b/pyproject.toml index 7501b7da070..73a42e69d99 100644 --- 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"