Changes between Version 2 and Version 3 of Ticket #20893
- Timestamp:
- 08/30/16 09:04:59 (3 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Ticket #20893
- Property Cc slelievre added
-
Property
Summary
changed from
improving live documentation in the Jupyter notebook
toImprove live documentation in the Jupyter notebook
-
Ticket #20893 – Description
v2 v3 3 3 Some of the improvements mentioned in #20690 were: 4 4 5 - [ ] Configure Sphinx to add a small header to our html page with Thebe configuration: use the Jupyter instance serving the page. We currently use `window.location.origin`; is this the right thing? 5 - [ ] Configure Sphinx to add a small header to our html page with 6 Thebe configuration: use the Jupyter instance serving the page. 7 We currently use `window.location.origin`; is this the right thing? 6 8 7 9 - [ ] Currently it takes 10s for 100 prompts while some sage files 8 9 10 contain up to 1000 prompts. Profile Thebe and optimize it or use 11 a separate thread to properly support large files. 10 12 11 - [ ] Expand the activate button with a menu or other widgets for user customization of the Jupyter server. This typically would let the user choose between:12 - tmpnb (will only be useful for Sage when tmpnb will include a13 Sage kernel)14 - A local Jupyter server15 - Whichever Jupyter server the browser is currently connected to?16 - a user specified server13 - [ ] Expand the activate button with a menu or other widgets for user customization 14 of the Jupyter server. This typically would let the user choose between: 15 - tmpnb (will only be useful for Sage when tmpnb will include a Sage kernel), 16 - a local Jupyter server, 17 - whichever Jupyter server the browser is currently connected to? 18 - a user-specified server. 17 19 18 20 - [ ] Check whether Jupyter could be configured to dynamically 19 20 21 22 you accept? yes/no/always for this site"21 negotiate incoming connections that don't fall within the 22 `-NotebookApp.allow_origin pattern`, by opening a user dialog such 23 as "Page xxx requests starting a new kernel on this server; do 24 you accept? yes/no/always for this site". 23 25 24 - [ ] Add support in Thebe for customizable (continuation) prompts, with striping and splitting as above, and automatic setting of the kernel. The customization option could look like: 25 {{{ 26 prompts = { 27 "sage: ": {continuations=["....:", "... "], kernel="sagemath"}, 28 ">>>> ": {continuation="... ", kernel="python"} 29 } 30 }}} 26 - [ ] Add support in Thebe for customizable (continuation) prompts, with striping 27 and splitting as above, and automatic setting of the kernel. The customization 28 option could look like: 29 {{{ 30 prompts = { 31 "sage: ": {continuations=["....:", "... "], kernel="sagemath"}, 32 ">>>> ": {continuation="... ", kernel="python"} 33 } 34 }}} 31 35 32 - [ ] Contribute support for Thebe upstream in Sphinx, with: 36 - [ ] Contribute support for Thebe upstream in [[http://www.sphinx-doc.org/en/stable/|Sphinx]], with: 37 - [ ] Explicit markup to specify which code blocks are editable and with 38 which kernel, or setup kernel auto-detection from the prompt. 39 - [ ] The possibility for setting a default value for the above. 33 40 34 - [ ] Explicit markup to specify which code blocks are editable 35 and with which kernel, or setup kernel auto-detection from 36 the prompt. 37 38 - [ ] The possibility for setting a default value for the above 39 40 - [ ] Refactor the Sage sphinx configuration to use the above 41 - [ ] Refactor the Sage sphinx configuration to use the above. 41 42 42 43 - [ ] Add support in Thebe for basic export to Jupyter notebooks. A 43 44 44 quality loss (in particular in terms of the hierarchical 45 structure) is acceptable. 45 46 46 - [ ] Have thebe.jsprovide good TAB completion.47 - [ ] Have Thebe provide good TAB completion.