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

Create an examples section in the Sphinx docs showing thebe working with popular libraries with custom outputs #253

Closed
7 of 8 tasks
moorepants opened this issue Oct 17, 2020 · 9 comments

Comments

@moorepants
Copy link
Collaborator

moorepants commented Oct 17, 2020

Many libraries implement custom outputs for rich display in Jupyter Notebook and Jupyter Lab, but they don't always display as expected with thebe. Some of these require some user tweaks to get working with thebe and sometimes there is a thebe issue that may prevent them from working. We can start by moving the things in the examples/ directory to the Sphinx docs in docs and then open PRs for new Sphinx pages showing off other libraries. Here are a list of some libraries:

You'll probably have to find a repo setup for repo2docker for each library that has the libraries properly installed (usually on that library's page) and use that for the page in the sphinx docs.

@moorepants
Copy link
Collaborator Author

@sandertyu created this repo showing some libraries that do and don't work that may be helpful. Some of that info could be transferred here to this issue if needed: https://github.com/sandertyu/widgetstuffs

@moorepants
Copy link
Collaborator Author

One other useful note is that many of these libraries can display custom Jupyter output that is essentially static wrt to the attached kernel (after the cell has been run) but that many examples also show off the interactive Jupyter widget functionality that is not static wrt to the attached kernel. The later may have more issues working than the former, so getting the former to work is the best starting point.

@moorepants
Copy link
Collaborator Author

I'm working on a pythreejs page.

@celine168
Copy link
Contributor

Noah and I are working on ipympl and ipyleaflet I believe.

@moorepants
Copy link
Collaborator Author

gonna try plotly now

@celine168
Copy link
Contributor

I'm working on ipycytoscape as well, forgot to mention that.

@celine168
Copy link
Contributor

As an update to these can be checked off:

@moorepants
Copy link
Collaborator Author

Done!

@moorepants
Copy link
Collaborator Author

There is an issue open for bokey support #112, so I'm closing this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants