Opened 3 years ago

Last modified 3 years ago

#20690 closed enhancement

Live documentation in Jupyter using Thebe — at Version 3

Reported by: nthiery Owned by:
Priority: major Milestone: sage-7.4
Component: documentation Keywords: days77, jupyter, thebe, notebook, sd75
Cc: vdelecroix, vbraun, rbeezer, slelievre, tmonteil Merged in:
Authors: Florent Cayré, Nicolas M. Thiéry Reviewers:
Report Upstream: N/A Work issues:
Branch: public/live_documentation_in_jupyter_using_thebe-20690 Commit: 19f31f8567ac77094d2ee483e7adf9d6963a8dd7
Dependencies: Stopgaps:

Description (last modified by nthiery)

Thebe is a Jupyter javascript plugin for static sites that allows for rendering selected divs of the HTML as live cells connected to a Jupyter server:

https://oreillymedia.github.io/thebe/

The idea is to use this technology to make

Steps:

  • Configure Sphinx to add the Thebe javascript library in the static page
  • Configure Sphinx to add a small header to our html page with:
    • Inclusion of the Thebe javascript
    • Thebe configuration: which divs to make live, which server to use
    • A button to turn on live cells
    • Possibly a menu or other widgets for user customization of the server configuration
  • Configure the Jupyter notebook in Sage to somehow provide the server configuration to Thebe.
  • Customize/configure Thebe to support Sage's doctest syntax:
    • Stripping out the prompts
    • Stripping out the included outputs (bonus: show the included outputs below the cell until the new output is computed)
    • Bonus: support doctests with several commands by split into several cells

Change History (3)

comment:1 Changed 3 years ago by nthiery

  • Branch set to u/nthiery/live_documentation_in_jupyter_using_thebe

comment:2 Changed 3 years ago by nthiery

  • Branch changed from u/nthiery/live_documentation_in_jupyter_using_thebe to public/live_documentation_in_jupyter_using_thebe-20690

comment:3 Changed 3 years ago by nthiery

  • Commit set to 19f31f8567ac77094d2ee483e7adf9d6963a8dd7
  • Description modified (diff)
  • Summary changed from Live documentation in Jupyter using thebe to Live documentation in Jupyter using Thebe

New commits:

19f31f820690: added some examples of sage code in a fast-to-compile document. DONT MERGE IN SAGE
Note: See TracTickets for help on using tickets.