Opened 2 years ago

Last modified 2 months ago

#28246 new enhancement

Use SageMathCell to embed interacts examples in the docs

Reported by: embray Owned by:
Priority: major Milestone: sage-9.5
Component: documentation Keywords:
Cc: Merged in:
Authors: Reviewers:
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description

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...

Change History (6)

comment:1 in reply to: ↑ description Changed 2 years ago by gh-mwageringel

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.

comment:2 Changed 21 months ago by embray

  • Milestone changed from sage-8.9 to sage-9.1

Ticket retargeted after milestone closed

comment:3 Changed 17 months ago by mkoeppe

  • Milestone changed from sage-9.1 to sage-9.2

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:4 Changed 13 months ago by mkoeppe

  • Milestone changed from sage-9.2 to sage-9.3

comment:5 Changed 7 months ago by mkoeppe

  • Milestone changed from sage-9.3 to sage-9.4

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

comment:6 Changed 2 months ago by mkoeppe

  • Milestone changed from sage-9.4 to sage-9.5
Note: See TracTickets for help on using tickets.