Skip to content

Commit 66950ef

Browse files
committed
docs update
1 parent c21b9ee commit 66950ef

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

chartlets.py/chartlets/components/charts/vega.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
from dataclasses import dataclass
22
from typing import Any
33

4+
5+
# Respect that "altair" is an optional dependency.
46
try:
57
# noinspection PyUnresolvedReferences
68
import altair
@@ -15,7 +17,11 @@
1517
@dataclass(frozen=True)
1618
class VegaChart(Component):
1719
"""A container for a
18-
[Vega Altair](https://altair-viz.github.io/) chart."""
20+
[Vega Altair](https://altair-viz.github.io/) chart.
21+
22+
Note: to use this component the `altair` package
23+
must be available in your python environment.
24+
"""
1925

2026
theme: str | None = None
2127
"""The name of a [Vega theme](https://vega.github.io/vega-themes/)."""

docs/api/components.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,11 @@ and providers:
99
- Application providers use the abstract base classes `Component` and
1010
`Container` to implement new specific components.
1111

12+
## Chart Components
1213

13-
## Specific Components
14+
::: chartlets.components.VegaChart
15+
16+
## Widget Components
1417

1518
::: chartlets.components.Box
1619

@@ -20,8 +23,6 @@ and providers:
2023

2124
::: chartlets.components.IconButton
2225

23-
::: chartlets.components.Plot
24-
2526
::: chartlets.components.Select
2627

2728
::: chartlets.components.Typography

0 commit comments

Comments
 (0)