#20690: Live documentation in Jupyter using Thebe
-------------------------------------+-------------------------------------
Reporter: nthiery | Owner:
Type: enhancement | Status: new
Priority: major | Milestone: sage-7.3
Component: documentation | Resolution:
Keywords: | Merged in:
Authors: Florent Cayré, | Reviewers:
Nicolas M. Thiéry | Work issues:
Report Upstream: N/A | Commit:
Branch: | 19f31f8567ac77094d2ee483e7adf9d6963a8dd7
public/live_documentation_in_jupyter_using_thebe-20690-experimental|
Stopgaps:
Dependencies: |
-------------------------------------+-------------------------------------
Description changed by nthiery:
Old description:
> 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:
> - [X] Configure Sphinx to add the Thebe javascript library in the static
> page
> - [/] Configure Sphinx to add a small header to our html page with:
> - [X] Inclusion of the Thebe javascript
> - [ ] Thebe configuration: which divs to make live, which server to use
> - [ ] A button to activate 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)
> - [ ] Support doctests with several commands by split into several
> cells
New description:
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:
- [X] Configure Sphinx to add the Thebe javascript library in the static
page
- [ / ] Configure Sphinx to add a small header to our html page with:
- [X] Inclusion of the Thebe javascript
- [x] Thebe configuration: which divs to make live
Currently, we include all <pre> tags that contain sage:
- [ ] Thebe configuration: use the Jupyter instance serving the page
We use window.location.origin; is this the right thing to do?
- [ ] Only activate Thebe if running inside a Jupyter server
- [x] A button to activate 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)
- [ ] Support doctests with several commands by spliting into several
cells
--
--
Ticket URL: <http://trac.sagemath.org/ticket/20690#comment:8>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
