Changes between Initial Version and Version 3 of Ticket #20690


Ignore:
Timestamp:
05/27/16 09:07:11 (4 years ago)
Author:
nthiery
Comment:

New commits:

19f31f820690: added some examples of sage code in a fast-to-compile document. DONT MERGE IN SAGE

Legend:

Unmodified
Added
Removed
Modified
  • Ticket #20690

    • Property Commit changed from to 19f31f8567ac77094d2ee483e7adf9d6963a8dd7
    • Property Branch changed from to public/live_documentation_in_jupyter_using_thebe-20690
    • Property Summary changed from Live documentation in Jupyter using thebe to Live documentation in Jupyter using Thebe
  • Ticket #20690 – Description

    initial v3  
     1Thebe 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:
     2
     3  https://oreillymedia.github.io/thebe/
     4
     5The idea is to use this technology to make
     6
     7Steps:
     8- Configure Sphinx to add the Thebe javascript library in the static page
     9- Configure Sphinx to add a small header to our html page with:
     10  - Inclusion of the Thebe javascript
     11  - Thebe configuration: which divs to make live, which server to use
     12  - A button to turn on live cells
     13  - Possibly a menu or other widgets for user customization of the server configuration
     14- Configure the Jupyter notebook in Sage to somehow provide the server configuration to Thebe.
     15- Customize/configure Thebe to support Sage's doctest syntax:
     16  - Stripping out the prompts
     17  - Stripping out the included outputs (bonus: show the included outputs below the cell until the new output is computed)
     18  - Bonus: support doctests with several commands by split into several cells