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
Comments
Replying to @embray:
Maybe this was here: https://sage-package.readthedocs.io/en/latest/sage_package/thebe.html. I can definitely see this being helpful. |
comment:2
Ticket retargeted after milestone closed |
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. |
comment:5
Setting new milestone based on a cursory review of ticket status, priority, and last modification date. |
comment:9
#33320 now fulfills the wishes of this ticket albeit with jupyter-sphinx rather than sagemath-cell. |
Hence closing |
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
The text was updated successfully, but these errors were encountered: