Combine all Rust code-examples into one binary (#4767)

### What
* Part of #4623
* Sibling PR: rerun-io/landing#611

This reduces the number of binaries in our workspace from 99 to 55.

We do this by joining all `docs/code-examples` into one binary, with a
little help from some `build.rs` codegen.
This will any compiler error messages to the wrong file though, so it is
not a perfect solution by any means.

I also decided to put all the code examples in their own folder
(`docs/code-examples/all`), with the control structures (`Cargo.toml`,
`CMakeLists`, …) in the parent folder (`docs/code-examples`). If you
have a better idea for a name than "all" I'm all ears.

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using newly built examples:
[app.rerun.io](https://app.rerun.io/pr/4767/index.html)
* Using examples from latest `main` build:
[app.rerun.io](https://app.rerun.io/pr/4767/index.html?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[app.rerun.io](https://app.rerun.io/pr/4767/index.html?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG

- [PR Build Summary](https://build.rerun.io/pr/4767)
- [Docs
preview](https://rerun.io/preview/84e36319d1a5ff181c1b436bc6e75e7be42bc05d/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/84e36319d1a5ff181c1b436bc6e75e7be42bc05d/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

---------

Co-authored-by: Andreas Reich <[email protected]>

.github/workflows/contrib_rerun_py.yml

@@ -40,6 +40,10 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - uses: prefix-dev/[email protected]
+        with:
+          pixi-version: v0.6.0
+
       # These should already be in the docker container, but run for good measure. A no-op install
       # should be fast, and this way things don't break if we add new packages without rebuilding
       # docker

.github/workflows/reusable_test_wheels.yml

@@ -121,6 +121,10 @@ jobs:
           workload_identity_provider: ${{ secrets.GOOGLE_WORKLOAD_IDENTITY_PROVIDER }}
           service_account: ${{ secrets.GOOGLE_SERVICE_ACCOUNT }}
 
+      - uses: prefix-dev/[email protected]
+        with:
+          pixi-version: v0.6.0
+
       # The pip-cache setup logic doesn't work in the ubuntu docker container
       # That's probably fine since we bake these deps into the container already
       - name: Setup python

crates/re_types/src/lib.rs

@@ -100,7 +100,7 @@
 //!
 //! ### Examples
 //!
-//! You can add an example to `docs/code-examples`, and then include its source code in
+//! You can add an example to `docs/code-examples/all`, and then include its source code in
 //! the docs using the `\example` tag. The example will also be included in the list of
 //! examples for type's generated docs.
 //!

crates/re_types_builder/src/bin/build_re_types.rs

@@ -13,7 +13,7 @@ use camino::Utf8Path;
 const RE_TYPES_SOURCE_HASH_PATH: &str = "crates/re_types/source_hash.txt";
 const DEFINITIONS_DIR_PATH: &str = "crates/re_types/definitions";
 const ENTRYPOINT_PATH: &str = "crates/re_types/definitions/rerun/archetypes.fbs";
-const DOC_EXAMPLES_DIR_PATH: &str = "docs/code-examples";
+const DOC_EXAMPLES_DIR_PATH: &str = "docs/code-examples/all";
 const CPP_OUTPUT_DIR_PATH: &str = "rerun_cpp";
 const PYTHON_OUTPUT_DIR_PATH: &str = "rerun_py/rerun_sdk/rerun";
 const PYTHON_TESTING_OUTPUT_DIR_PATH: &str = "rerun_py/tests/test_types";

crates/re_types_builder/src/codegen/common.rs

@@ -250,7 +250,7 @@ pub fn collect_examples_for_api_docs<'a>(
     let mut out = Vec::new();
 
     if let Some(examples) = docs.tagged_docs.get("example") {
-        let base_path = crate::rerun_workspace_path().join("docs/code-examples");
+        let base_path = crate::rerun_workspace_path().join("docs/code-examples/all");
 
         for base @ ExampleInfo {
             name,

crates/re_viewer/data/quick_start_guides/quick_start_connect.cpp

@@ -1 +1 @@
-../../../../docs/code-examples/quick_start_connect.cpp
+../../../../docs/code-examples/all/quick_start_connect.cpp

crates/re_viewer/data/quick_start_guides/quick_start_connect.py

@@ -1 +1 @@
-../../../../docs/code-examples/quick_start_connect.py
+../../../../docs/code-examples/all/quick_start_connect.py

crates/re_viewer/data/quick_start_guides/quick_start_connect.rs

@@ -1 +1 @@
-../../../../docs/code-examples/quick_start_connect.rs
+../../../../docs/code-examples/all/quick_start_connect.rs

crates/re_viewer/data/quick_start_guides/quick_start_spawn.py

@@ -1 +1 @@
-../../../../docs/code-examples/quick_start_spawn.py
+../../../../docs/code-examples/all/quick_start_spawn.py

crates/re_viewer/data/quick_start_guides/quick_start_spawn.rs

@@ -1 +1 @@
-../../../../docs/code-examples/quick_start_spawn.rs
+../../../../docs/code-examples/all/quick_start_spawn.rs

docs/README.md

@@ -14,14 +14,15 @@ The site documentation lives in Markdown files inside [`/content`](./content).
 
 The entry point to the documentation is [`/content/index.md`](./content/index.md)
 
-Code examples can be rendered in multiple languages by placing them in `code-examples`, like so:
+Code examples can be rendered in multiple languages by placing them in `code-examples/all`, like so:
 
 ```
 /docs
-    /code-examples
-        /my-example
-            /example.py
-            /example.rs
+  /code-examples
+    /all
+      /my-example
+        /example.py
+        /example.rs
 ```
 
 ## Special syntax

docs/code-examples/CMakeLists.txt

@@ -1,10 +1,10 @@
 cmake_minimum_required(VERSION 3.16...3.27)
 
 # Setup builds for examples
-file(GLOB sources_list true ${CMAKE_CURRENT_SOURCE_DIR}/*.cpp)
+file(GLOB sources_list true ${CMAKE_CURRENT_SOURCE_DIR}/all/*.cpp)
 
 # TODO(ab): incomplete code, need hideable stubs, see https://github.com/rerun-io/landing/issues/515
-list(REMOVE_ITEM sources_list ${CMAKE_CURRENT_SOURCE_DIR}/timelines_example.cpp)
+list(REMOVE_ITEM sources_list ${CMAKE_CURRENT_SOURCE_DIR}/all/timelines_example.cpp)
 
 add_custom_target(doc_examples)
 

docs/code-examples/Cargo.toml

@@ -6,188 +6,12 @@ rust-version.workspace = true
 license.workspace = true
 publish = false
 
-
-[[bin]]
-name = "annotation_context_connections"
-path = "annotation_context_connections.rs"
-
-[[bin]]
-name = "annotation_context_rects"
-path = "annotation_context_rects.rs"
-
-[[bin]]
-name = "annotation_context_segmentation"
-path = "annotation_context_segmentation.rs"
-
-[[bin]]
-name = "arrow2d_simple"
-path = "arrow2d_simple.rs"
-
-[[bin]]
-name = "arrow3d_simple"
-path = "arrow3d_simple.rs"
-
-[[bin]]
-name = "bar_chart"
-path = "bar_chart.rs"
-
-[[bin]]
-name = "asset3d_simple"
-path = "asset3d_simple.rs"
-
-[[bin]]
-name = "asset3d_out_of_tree"
-path = "asset3d_out_of_tree.rs"
-
-[[bin]]
-name = "box2d_simple"
-path = "box2d_simple.rs"
-
-[[bin]]
-name = "box3d_simple"
-path = "box3d_simple.rs"
-
-[[bin]]
-name = "box3d_batch"
-path = "box3d_batch.rs"
-
-[[bin]]
-name = "clear_recursive"
-path = "clear_recursive.rs"
-
-[[bin]]
-name = "clear_simple"
-path = "clear_simple.rs"
-
-[[bin]]
-name = "custom_data"
-path = "custom_data.rs"
-
-[[bin]]
-name = "depth_image_3d"
-path = "depth_image_3d.rs"
-
-[[bin]]
-name = "depth_image_simple"
-path = "depth_image_simple.rs"
-
-[[bin]]
-name = "disconnected_space"
-path = "disconnected_space.rs"
-
-[[bin]]
-name = "entity_path"
-path = "entity_path.rs"
-
-[[bin]]
-name = "image_simple"
-path = "image_simple.rs"
-
-[[bin]]
-name = "line_segments2d_simple"
-path = "line_segments2d_simple.rs"
-
-[[bin]]
-name = "line_segments3d_simple"
-path = "line_segments3d_simple.rs"
-
-[[bin]]
-name = "line_strip2d_simple"
-path = "line_strip2d_simple.rs"
-
-[[bin]]
-name = "line_strip2d_batch"
-path = "line_strip2d_batch.rs"
-
-[[bin]]
-name = "line_strip3d_simple"
-path = "line_strip3d_simple.rs"
-
-[[bin]]
-name = "line_strip3d_batch"
-path = "line_strip3d_batch.rs"
-
-[[bin]]
-name = "manual_indicator"
-path = "manual_indicator.rs"
-
-[[bin]]
-name = "mesh3d_simple"
-path = "mesh3d_simple.rs"
-
-[[bin]]
-name = "mesh3d_indexed"
-path = "mesh3d_indexed.rs"
-
-[[bin]]
-name = "mesh3d_partial_updates"
-path = "mesh3d_partial_updates.rs"
-
-[[bin]]
-name = "pinhole_simple"
-path = "pinhole_simple.rs"
-
-[[bin]]
-name = "point2d_simple"
-path = "point2d_simple.rs"
-
-[[bin]]
-name = "point2d_random"
-path = "point2d_random.rs"
-
-[[bin]]
-name = "point3d_random"
-path = "point3d_random.rs"
-
-[[bin]]
-name = "point3d_simple"
-path = "point3d_simple.rs"
-
-[[bin]]
-name = "quick_start_connect"
-path = "quick_start_connect.rs"
-
-[[bin]]
-name = "quick_start_spawn"
-path = "quick_start_spawn.rs"
-
-[[bin]]
-name = "scalar_simple"
-path = "scalar_simple.rs"
-
-[[bin]]
-name = "scalar_multiple_plots"
-path = "scalar_multiple_plots.rs"
-
-[[bin]]
-name = "segmentation_image_simple"
-path = "segmentation_image_simple.rs"
-
-[[bin]]
-name = "tensor_simple"
-path = "tensor_simple.rs"
-
-[[bin]]
-name = "text_document"
-path = "text_document.rs"
-
-[[bin]]
-name = "text_log"
-path = "text_log.rs"
-
-[[bin]]
-name = "text_log_integration"
-path = "text_log_integration.rs"
-
-[[bin]]
-name = "transform3d_simple"
-path = "transform3d_simple.rs"
-
-[[bin]]
-name = "view_coordinates_simple"
-path = "view_coordinates_simple.rs"
-
 [dependencies]
 ndarray.workspace = true
 rand.workspace = true
 rerun = { path = "../../crates/rerun" }
+
+[build-dependencies]
+itertools.workspace = true
+re_build_tools.workspace = true
+rust-format.workspace = true

docs/code-examples/README.md

@@ -9,10 +9,10 @@ Most of these examples are automatically used as docstrings for the `Archetype`
 You can run each example individually using the following:
 
 - **C++**:
-  - `pixi run cpp-build-examples` to compile all examples
-  - `./build/docs/code-examples/<example_name>` to run, e.g. `./build/docs/code-examples/point3d_random`
+  - `pixi run cpp-build-doc-examples` to compile all examples
+  - `./build/docs/code-examples/all/<example_name>` to run, e.g. `./build/docs/code-examples/all/point3d_random`
 - **Python**: `python <example_name>.py`, e.g. `python point3d_random.py`.
-- **Rust**: `cargo r -p code_examples --bin <example_name`, e.g. `cargo r -p code_examples --bin point3d_random`.
+- **Rust**: `cargo run -p code_examples -- <example_name> [args]`, e.g. `cargo run -p code_examples -- point3d_random`.
 
 ## Roundtrips
 
@@ -31,6 +31,3 @@ To run the roundtrip tests, check out `./docs/code-examples/roundtrips.py --help
 Just pick a name for your test, and look at existing examples to get started. The `app_id` must be `rerun_example_<test_name>`.
 
 The roundtrip process is driven by file names, so make sure all 3 tests use the same name: `<test_name>.rs`, `<test_name>.cpp`, `<test_name>.py`.
-
-For Rust, also make sure to declare the new binary in `docs/code-examples/Cargo.toml`.
-