diff --git a/crates/build/re_types_builder/src/codegen/docs/snippets_ref.rs b/crates/build/re_types_builder/src/codegen/docs/snippets_ref.rs index 5dfcc757ad88..82e46adf2c22 100644 --- a/crates/build/re_types_builder/src/codegen/docs/snippets_ref.rs +++ b/crates/build/re_types_builder/src/codegen/docs/snippets_ref.rs @@ -13,6 +13,25 @@ use crate::{CodeGenerator, GeneratedFiles, Object, ObjectKind, Objects, Reporter // --- +/// See `docs/snippets/snippets.toml` for more info +#[derive(Debug, serde::Deserialize)] +struct Config { + snippets_ref: SnippetsRef, +} + +#[derive(Debug, serde::Deserialize)] +struct SnippetsRef { + snippets: OptOut, + archetypes: OptOut, + components: OptOut, +} + +#[derive(Debug, serde::Deserialize)] +struct OptOut { + // > + opt_out: BTreeMap>, +} + /// Everything we know about a snippet, including which objects (archetypes, components, etc) it references. #[allow(dead_code)] #[derive(Debug, Clone)] @@ -117,6 +136,10 @@ impl SnippetsRefCodeGenerator { let snippets_dir_root = snippets_dir.join("all"); let snippets_dir_archetypes = snippets_dir_root.clone(); + let config_path = snippets_dir.join("snippets.toml"); + let config = std::fs::read_to_string(config_path)?; + let config: Config = toml::from_str(&config)?; + let known_objects = KnownObjects::init(objects); let snippets = collect_snippets_recursively( @@ -180,6 +203,10 @@ impl SnippetsRefCodeGenerator { Ok(row) } + let opt_outs = &config.snippets_ref.snippets.opt_out; + let archetype_opt_outs = &config.snippets_ref.archetypes.opt_out; + let component_opt_outs = &config.snippets_ref.components.opt_out; + let snippets_table = |snippets: &BTreeMap<&Object, Vec>>| { let table = snippets .iter() @@ -198,6 +225,29 @@ impl SnippetsRefCodeGenerator { }); snippets.into_iter().map(move |snippet| (obj, snippet)) }) + .filter(|(obj, snippet)| { + if opt_outs.contains_key(&snippet.name_qualified) { + return false; + } + + if obj.kind == ObjectKind::Archetype { + if let Some(opt_outs) = archetype_opt_outs.get(&obj.name) { + if opt_outs.contains(&snippet.name_qualified) { + return false; + } + } + } + + if obj.kind == ObjectKind::Component { + if let Some(opt_outs) = component_opt_outs.get(&obj.name) { + if opt_outs.contains(&snippet.name_qualified) { + return false; + } + } + } + + true + }) .map(|(obj, snippet)| snippet_row(obj, &snippet)) .collect::, _>>()? .join("\n"); diff --git a/docs/snippets/INDEX.md b/docs/snippets/INDEX.md index 63c8a5d11c82..42cee4ca5457 100644 --- a/docs/snippets/INDEX.md +++ b/docs/snippets/INDEX.md @@ -101,7 +101,6 @@ _All snippets, organized by the [`Archetype`](https://rerun.io/docs/reference/ty | **[`Mesh3D`](https://rerun.io/docs/reference/types/archetypes/mesh3d)** | `archetypes/mesh3d_partial_updates` | Log a simple colored triangle, then update its vertices' positions each frame | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/mesh3d_partial_updates.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/mesh3d_partial_updates.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/mesh3d_partial_updates.cpp) | | **[`Mesh3D`](https://rerun.io/docs/reference/types/archetypes/mesh3d)** | `archetypes/mesh3d_instancing` | Log a simple 3D mesh with several instance pose transforms which instantiate the mesh several times and will not affect its children (known as mesh instancing) | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/mesh3d_instancing.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/mesh3d_instancing.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/mesh3d_instancing.cpp) | | **[`Mesh3D`](https://rerun.io/docs/reference/types/archetypes/mesh3d)** | `archetypes/mesh3d_indexed` | Log a simple colored triangle | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/mesh3d_indexed.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/mesh3d_indexed.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/mesh3d_indexed.cpp) | -| **[`Mesh3D`](https://rerun.io/docs/reference/types/archetypes/mesh3d)** | `archetypes/manual_indicator` | Shows how to manually associate one or more indicator components with arbitrary data | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/manual_indicator.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/manual_indicator.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/manual_indicator.cpp) | | **[`Pinhole`](https://rerun.io/docs/reference/types/archetypes/pinhole)** | `archetypes/pinhole_simple` | Log a pinhole and a random image | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/pinhole_simple.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/pinhole_simple.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/pinhole_simple.cpp) | | **[`Pinhole`](https://rerun.io/docs/reference/types/archetypes/pinhole)** | `archetypes/pinhole_perspective` | Logs a point cloud and a perspective camera looking at it | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/pinhole_perspective.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/pinhole_perspective.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/pinhole_perspective.cpp) | | **[`Pinhole`](https://rerun.io/docs/reference/types/archetypes/pinhole)** | `archetypes/depth_image_3d` | Create and log a depth image and pinhole camera | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/depth_image_3d.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/depth_image_3d.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/depth_image_3d.cpp) | @@ -118,7 +117,6 @@ _All snippets, organized by the [`Archetype`](https://rerun.io/docs/reference/ty | **[`Points3D`](https://rerun.io/docs/reference/types/archetypes/points3d)** | `archetypes/disconnected_space` | Disconnect two spaces | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/disconnected_space.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/disconnected_space.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/disconnected_space.cpp) | | **[`Points3D`](https://rerun.io/docs/reference/types/archetypes/points3d)** | `archetypes/ellipsoid3d_simple` | Log random points and the corresponding covariance ellipsoid | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/ellipsoid3d_simple.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/ellipsoid3d_simple.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/ellipsoid3d_simple.cpp) | | **[`Points3D`](https://rerun.io/docs/reference/types/archetypes/points3d)** | `archetypes/instance_poses3d_combined` | Log a simple 3D box with a regular & instance pose transform | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/instance_poses3d_combined.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/instance_poses3d_combined.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/instance_poses3d_combined.cpp) | -| **[`Points3D`](https://rerun.io/docs/reference/types/archetypes/points3d)** | `archetypes/manual_indicator` | Shows how to manually associate one or more indicator components with arbitrary data | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/manual_indicator.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/manual_indicator.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/manual_indicator.cpp) | | **[`Points3D`](https://rerun.io/docs/reference/types/archetypes/points3d)** | `archetypes/pinhole_perspective` | Logs a point cloud and a perspective camera looking at it | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/pinhole_perspective.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/pinhole_perspective.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/pinhole_perspective.cpp) | | **[`Points3D`](https://rerun.io/docs/reference/types/archetypes/points3d)** | `archetypes/point3d_random` | Log some random points with color and radii | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/point3d_random.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/point3d_random.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/point3d_random.cpp) | | **[`Points3D`](https://rerun.io/docs/reference/types/archetypes/points3d)** | `archetypes/point3d_simple` | Log some very simple points | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/point3d_simple.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/point3d_simple.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/point3d_simple.cpp) | @@ -187,7 +185,6 @@ _All snippets, organized by the [`Component`](https://rerun.io/docs/reference/ty | **[`AnnotationContext`](https://rerun.io/docs/reference/types/components/annotation_context)** | `archetypes/annotation_context_connections` | Log annotation context with connections between keypoints | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/annotation_context_connections.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/annotation_context_connections.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/annotation_context_connections.cpp) | | **[`AnnotationContext`](https://rerun.io/docs/reference/types/components/annotation_context)** | `archetypes/segmentation_image_simple` | Create and log a segmentation image | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/segmentation_image_simple.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/segmentation_image_simple.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/segmentation_image_simple.cpp) | | **[`AnnotationContext`](https://rerun.io/docs/reference/types/components/annotation_context)** | `tutorials/annotation-context` | | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/tutorials/annotation-context.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/tutorials/annotation-context.rs) | | -| **[`Color`](https://rerun.io/docs/reference/types/components/color)** | `archetypes/manual_indicator` | Shows how to manually associate one or more indicator components with arbitrary data | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/manual_indicator.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/manual_indicator.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/manual_indicator.cpp) | | **[`Color`](https://rerun.io/docs/reference/types/components/color)** | `archetypes/points3d_send_columns` | Use the `send_columns` API to send several point clouds over time in a single call | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/points3d_send_columns.py) | | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/points3d_send_columns.cpp) | | **[`Color`](https://rerun.io/docs/reference/types/components/color)** | `concepts/different_data_per_timeline` | Log different data on different timelines | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/concepts/different_data_per_timeline.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/concepts/different_data_per_timeline.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/concepts/different_data_per_timeline.cpp) | | **[`Color`](https://rerun.io/docs/reference/types/components/color)** | `concepts/viscomp-component-default` | Add a component default | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/concepts/viscomp-component-default.py) | | | @@ -208,7 +205,6 @@ _All snippets, organized by the [`Component`](https://rerun.io/docs/reference/ty | **[`MediaType`](https://rerun.io/docs/reference/types/components/media_type)** | `archetypes/text_document` | Log a `TextDocument` | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/text_document.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/text_document.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/text_document.cpp) | | **[`MediaType`](https://rerun.io/docs/reference/types/components/media_type)** | `views/text_document` | Use a blueprint to show a text document | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/views/text_document.py) | | | | **[`Plane3D`](https://rerun.io/docs/reference/types/components/plane3d?speculative-link)** | `views/spatial3d` | Use a blueprint to customize a Spatial3DView | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/views/spatial3d.py?speculative-link) | | | -| **[`Position3D`](https://rerun.io/docs/reference/types/components/position3d)** | `archetypes/manual_indicator` | Shows how to manually associate one or more indicator components with arbitrary data | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/manual_indicator.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/manual_indicator.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/manual_indicator.cpp) | | **[`Position3D`](https://rerun.io/docs/reference/types/components/position3d)** | `archetypes/mesh3d_partial_updates` | Log a simple colored triangle, then update its vertices' positions each frame | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/mesh3d_partial_updates.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/mesh3d_partial_updates.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/mesh3d_partial_updates.cpp) | | **[`Position3D`](https://rerun.io/docs/reference/types/components/position3d)** | `archetypes/points3d_send_columns` | Use the `send_columns` API to send several point clouds over time in a single call | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/points3d_send_columns.py) | | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/points3d_send_columns.cpp) | | **[`Position3D`](https://rerun.io/docs/reference/types/components/position3d)** | `descriptors/descr_builtin_component` | | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/descriptors/descr_builtin_component.py?speculative-link) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/descriptors/descr_builtin_component.rs?speculative-link) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/descriptors/descr_builtin_component.cpp?speculative-link) | @@ -220,7 +216,6 @@ _All snippets, organized by the [`Component`](https://rerun.io/docs/reference/ty | **[`Radius`](https://rerun.io/docs/reference/types/components/radius)** | `archetypes/line_strip2d_ui_radius` | Log lines with ui points & scene unit radii | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/line_strip2d_ui_radius.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/line_strip2d_ui_radius.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/line_strip2d_ui_radius.cpp) | | **[`Radius`](https://rerun.io/docs/reference/types/components/radius)** | `archetypes/geo_line_string_simple` | Log a simple geospatial line string | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/geo_line_string_simple.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/geo_line_string_simple.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/geo_line_string_simple.cpp) | | **[`Radius`](https://rerun.io/docs/reference/types/components/radius)** | `archetypes/geo_point_simple` | Log some very simple geospatial point | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/geo_point_simple.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/geo_point_simple.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/geo_point_simple.cpp) | -| **[`Radius`](https://rerun.io/docs/reference/types/components/radius)** | `archetypes/manual_indicator` | Shows how to manually associate one or more indicator components with arbitrary data | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/manual_indicator.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/manual_indicator.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/manual_indicator.cpp) | | **[`Radius`](https://rerun.io/docs/reference/types/components/radius)** | `concepts/different_data_per_timeline` | Log different data on different timelines | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/concepts/different_data_per_timeline.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/concepts/different_data_per_timeline.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/concepts/different_data_per_timeline.cpp) | | **[`Radius`](https://rerun.io/docs/reference/types/components/radius)** | `views/map` | Use a blueprint to customize a map view | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/views/map.py) | | | | **[`RotationAxisAngle`](https://rerun.io/docs/reference/types/components/rotation_axis_angle)** | `archetypes/capsule3d_batch` | Log a batch of capsules | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/capsule3d_batch.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/capsule3d_batch.rs) | [🌊](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/archetypes/capsule3d_batch.cpp) | @@ -240,7 +235,6 @@ _All snippets, organized by the [`Component`](https://rerun.io/docs/reference/ty | **[`Scalar`](https://rerun.io/docs/reference/types/components/scalar)** | `views/dataframe` | Use a blueprint to customize a DataframeView | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/views/dataframe.py) | | | | **[`Scalar`](https://rerun.io/docs/reference/types/components/scalar)** | `views/tensor` | Use a blueprint to show a tensor view | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/views/tensor.py) | | | | **[`Scalar`](https://rerun.io/docs/reference/types/components/scalar)** | `views/timeseries` | Use a blueprint to customize a TimeSeriesView | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/views/timeseries.py) | | | -| **[`ShowLabels`](https://rerun.io/docs/reference/types/components/show_labels)** | `tutorials/data_out` | | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/tutorials/data_out.py) | | | | **[`TensorDimensionIndexSelection`](https://rerun.io/docs/reference/types/components/tensor_dimension_index_selection)** | `views/tensor` | Use a blueprint to show a tensor view | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/views/tensor.py) | | | | **[`Text`](https://rerun.io/docs/reference/types/components/text)** | `views/text_log` | Use a blueprint to show a text log | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/views/text_log.py) | | | | **[`Text`](https://rerun.io/docs/reference/types/components/text)** | `views/text_document` | Use a blueprint to show a text document | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/views/text_document.py) | | | @@ -310,7 +304,6 @@ _All snippets, organized by the blueprint-related [`Archetype`](https://rerun.io | Archetype | Snippet | Description | Python | Rust | C++ | | --------- | ------- | ----------- | ------ | ---- | --- | | **`Background`** | `tutorials/annotation-context` | | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/tutorials/annotation-context.py) | [🦀](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/tutorials/annotation-context.rs) | | -| **`DataframeQuery`** | `reference/dataframe_save_blueprint` | Craft a blueprint with the python API and save it to a file for future use | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/reference/dataframe_save_blueprint.py) | | | | **`DataframeQuery`** | `reference/dataframe_view_query` | Query and display the first 10 rows of a recording in a dataframe view | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/reference/dataframe_view_query.py) | | | | **`DataframeQuery`** | `views/dataframe` | Use a blueprint to customize a DataframeView | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/views/dataframe.py) | | | | **`LineGrid3D`** | `views/spatial3d` | Use a blueprint to customize a Spatial3DView | [🐍](https://github.com/rerun-io/rerun/blob/latest/docs/snippets/all/views/spatial3d.py) | | | diff --git a/docs/snippets/snippets.toml b/docs/snippets/snippets.toml index d2eddf3d904b..65c385d36c04 100644 --- a/docs/snippets/snippets.toml +++ b/docs/snippets/snippets.toml @@ -1,5 +1,21 @@ # This file is read in `compare_snippet_output.py` and the `snippets` command in `re_dev_tools`/`build_examples`. +# These snippets will be excluded from the snippet index, unconditionally. +[snippets_ref.snippets.opt_out] +"archetypes/manual_indicator" = [] + +# These archetypes will ignore the associated snippets in the snippet index. +[snippets_ref.archetypes.opt_out] +"DataframeQuery" = [ + "reference/dataframe_save_blueprint" +] + +# These components will ignore the associated snippets in the snippet index. +[snippets_ref.components.opt_out] +"ShowLabels" = [ + "tutorials/data_out", +] + # These entries won't run at all. # # You should only ever use this if the test isn't implemented and cannot yet be implemented