widgetti / widgetti/solara

Use in static documentation sites?

Open
#449 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
2.2k
Forks
202
Avg merge
4h 36m
Merged PRs (30d)
3

Description

I'm really impressed with solara so far. Thank you so much for your time.

I have a project which has a static site for documentation. I have some example notebooks in there that are run to generate the HTML using mkdocs and mkdocs-jupyter. Before, I was using plain old altair charts. But now I want to make them more interactive with solara components. However, now the staticly built example pages don't render the widgets correctly, because there is no backend to connect to. It says Cannot show widget. You probably want to rerun the code cell above (Click in the code cell, and press Shift+Enter ⇧+↩). The example page I'm taking about is here (cell number 3, where it uses distribution_dashboard())

Do you have suggestions as to how I can present these examples with the live widgets still working? Can we make solara work with jupyterlite? If I try pip installing Solara in jupyterlite there are a few dependencies like watchdog that don't have wasm wheels and this Solara fails to install. Can we make these deps optional (no filesystem in jupyterlite anyways...) or otherwise fix them?

Should I put these examples in a binder or colab instance and just link to them? It would be very nice if I didn't have to link out, and the examples could just live on the static github pages site.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked static documentation example, especially cell 3 using distribution_dashboard(), and reproduce the widget rendering failure. Then investigate the reported JupyterLite installation failures involving watchdog and other dependencies. Done means a documented or implemented way for Solara widgets to work in static documentation pages, or a clear supported alternative such as Binder or Colab.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter, jupyter-notebook, python
Domain
documentation, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.