Skip to content

docs: Update our instructions for installing kaleido #1195

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

Merged
mofojed merged 1 commit into from
Jun 24, 2025
Merged

docs: Update our instructions for installing kaleido #1195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 6 additions & 4 deletions plugins/plotly-express/docs/static-image-export.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ Either install will `all` extras or install `kaleido` separately.
```sh
pip install 'deephaven-plugin-plotly-express[all]'
```

or

```sh
pip install kaleido
pip install "kaleido<1.0.0"
```

> [!WARNING]
Expand Down Expand Up @@ -37,7 +39,7 @@ line_plot_image = ui.image(src=line_plot_bytes)

## Theme Template

Customize the theme with the `template` argument.
Customize the theme with the `template` argument.
Default options are `"plotly"`, `"plotly_white"`, `"plotly_dark"`, `"ggplot2"`, `"seaborn"`, and `"simple_white"`.

```python order=line_plot_image
Expand All @@ -57,7 +59,7 @@ line_plot_image = ui.image(src=line_plot_bytes)

## Image Format

Customize the format with the `format` argument.
Customize the format with the `format` argument.
Options are `"png"`, `"jpg"`, `"jpeg"`, `"webp"`, `"svg"`, and `"pdf"`.

```python order=line_plot_image
Expand Down Expand Up @@ -111,4 +113,4 @@ line_plot_bytes = line_plot.to_image()
# Write the image to a file in the current directory
with open("line_plot.png", "wb") as f:
f.write(line_plot_bytes)
```
```
2 changes: 1 addition & 1 deletion plugins/plotly-express/setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ install_requires =
include_package_data = True

[options.extras_require]
all = kaleido
all = kaleido<1.0.0

[options.packages.find]
where=src
Expand Down
Loading