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.

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

Snippet index: support for manual opt-outs #8385

Merged
merged 1 commit into from
Dec 10, 2024

Conversation

teh-cmc
Copy link
Member

@teh-cmc teh-cmc commented Dec 10, 2024

Adds the ability to manually opt-out of the index for specific snippets/archetypes/components.

E.g.:

# 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",
]

Config will have to be filled over time!

Rendered

@teh-cmc teh-cmc added 📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples do-not-merge Do not merge this PR exclude from changelog PRs with this won't show up in CHANGELOG.md labels Dec 10, 2024
Copy link

github-actions bot commented Dec 10, 2024

Web viewer failed to build.

| Result | Commit | Link | Manifest |
| ------ | ------- | ----- |
| ❌ | | https://rerun.io/viewer/pr/8385 | +nightly +main |

Note: This comment is updated whenever you push a commit.

Copy link
Member

@Wumpf Wumpf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@teh-cmc teh-cmc force-pushed the cmc/snippets_index_1_autogen branch from 3493bfa to 8aaa8a8 Compare December 10, 2024 16:34
Base automatically changed from cmc/snippets_index_1_autogen to main December 10, 2024 16:35
@teh-cmc teh-cmc force-pushed the cmc/snippets_index_2_opt_outs branch from 0315edb to f627739 Compare December 10, 2024 16:36
@teh-cmc teh-cmc removed the do-not-merge Do not merge this PR label Dec 10, 2024
@teh-cmc teh-cmc merged commit 7d0036e into main Dec 10, 2024
25 of 29 checks passed
@teh-cmc teh-cmc deleted the cmc/snippets_index_2_opt_outs branch December 10, 2024 16:36
teh-cmc added a commit that referenced this pull request Dec 10, 2024
Adds the ability to manually enumerate custom things.

E.g.:
```toml
# These arbitrary feature names will be indexed exactly as written down.
# Add anything you can think about!
[snippets_ref.features]
"Dataframes" = [
  "reference/dataframe_query",
  "reference/dataframe_view_query",
]
"`AnyValue`" = [
  "tutorials/any_values",
  "tutorials/extra_values",
  "howto/any_values_send_columns",
]
```

Config will have to be filled over time!


[Rendered](https://github.com/rerun-io/rerun/blob/cmc/snippets_index_3_features/docs/snippets/INDEX.md)

* Part of #1123
* Part of #5662
* DNM: requires #8385
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples exclude from changelog PRs with this won't show up in CHANGELOG.md
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants