Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make examples setup a separate page #2323

Merged
merged 3 commits into from
Jun 7, 2023
Merged

Make examples setup a separate page #2323

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d71d2b6
make setup a separate page
jprochazk Jun 7, 2023
b547394
Merge branch 'main' into jan/examples-setup-separate
jprochazk Jun 7, 2023
1f66e4b
Merge branch 'main' into jan/examples-setup-separate
jprochazk Jun 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions examples/manifest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,21 +39,22 @@ root:
clone of the repository. Many of the Python examples need additional dependencies
set up in a `requirements.txt` next to the example. These are noted in the
individual example sections below.

## Setup

Make sure you have the Rerun repository checked out and the latest SDK installed.

```bash
pip install --upgrade rerun-sdk # install the latest Rerun SDK
git clone [email protected]:rerun-io/rerun.git # Clone the repository
cd rerun
git checkout latest # Check out the commit matching the latest SDK release
```
> Note: Make sure your SDK version matches the examples.
For example, if your SDK version is `0.3.1`, check out the matching tag
in the Rerun repository by running `git checkout v0.3.1`.
children:
- name: setup
title: Setup
prelude: |
Make sure you have the Rerun repository checked out and the latest SDK installed.

```bash
pip install --upgrade rerun-sdk # install the latest Rerun SDK
git clone [email protected]:rerun-io/rerun.git # Clone the repository
cd rerun
git checkout latest # Check out the commit matching the latest SDK release
```
> Note: Make sure your SDK version matches the examples.
For example, if your SDK version is `0.3.1`, check out the matching tag
in the Rerun repository by running `git checkout v0.3.1`.

- name: artificial-data
title: Examples with Artificial Data
prelude: |
Expand Down