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

Use SageMathCell to embed interacts examples in the docs #28246

Closed
embray opened this issue Jul 24, 2019 · 6 comments
Closed

Use SageMathCell to embed interacts examples in the docs #28246

embray opened this issue Jul 24, 2019 · 6 comments

Comments

@embray
Copy link
Contributor

embray commented Jul 24, 2019

The official Interact Quickstart in the documentation lacks example output, making it a bit unimpressive to readers, who might not otherwise be sufficiently motivated to try it themselves.

The page does link to http://wiki.sagemath.org/interact, which shows an interactive example in SageMathCell, but it would be better if the actual examples in the docs worked interactively as well.

I think it would be straightforward to add a special Sphinx directive for embedding an interactive cell. Obviously, it would only work when viewing the docs with an internet connection. For when it doesn't work, it would also be nice if the directive could be supplied a fallback screenshot (ideally, and interactive GIF). These fallback screenshots would have to be supplied manually, unfortunately.

Adding a special directive would be ideal since it would make it easier to provide interact examples in other parts of the docs as well.

An even more sophisticated possibility would be a button to turn any examples in the docs into interactive cells. I feel like this has been tried before, but I don't remember where I've seen it...

CC: @kwankyu

Component: documentation

Issue created by migration from https://trac.sagemath.org/ticket/28246

@embray embray added this to the sage-8.9 milestone Jul 24, 2019
@mwageringel
Copy link

Replying to @embray:

An even more sophisticated possibility would be a button to turn any examples in the docs into interactive cells. I feel like this has been tried before, but I don't remember where I've seen it...

Maybe this was here: https://sage-package.readthedocs.io/en/latest/sage_package/thebe.html. I can definitely see this being helpful.

@embray
Copy link
Contributor Author

embray commented Dec 30, 2019

comment:2

Ticket retargeted after milestone closed

@embray embray modified the milestones: sage-8.9, sage-9.1 Dec 30, 2019
@mkoeppe
Copy link
Member

mkoeppe commented Apr 14, 2020

comment:3

Batch modifying tickets that will likely not be ready for 9.1, based on a review of the ticket title, branch/review status, and last modification date.

@mkoeppe mkoeppe modified the milestones: sage-9.1, sage-9.2 Apr 14, 2020
@mkoeppe mkoeppe modified the milestones: sage-9.2, sage-9.3 Aug 29, 2020
@mkoeppe
Copy link
Member

mkoeppe commented Feb 13, 2021

comment:5

Setting new milestone based on a cursory review of ticket status, priority, and last modification date.

@mkoeppe mkoeppe modified the milestones: sage-9.3, sage-9.4 Feb 13, 2021
@mkoeppe mkoeppe modified the milestones: sage-9.4, sage-9.5 Jul 19, 2021
@mkoeppe mkoeppe modified the milestones: sage-9.5, sage-9.6 Dec 18, 2021
@kwankyu
Copy link
Collaborator

kwankyu commented Apr 3, 2022

comment:9

#33320 now fulfills the wishes of this ticket albeit with jupyter-sphinx rather than sagemath-cell.

@mkoeppe
Copy link
Member

mkoeppe commented Feb 29, 2024

#33320 now fulfills the wishes of this ticket albeit with jupyter-sphinx rather than sagemath-cell.

Hence closing

@mkoeppe mkoeppe closed this as not planned Won't fix, can't repro, duplicate, stale Feb 29, 2024
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

4 participants