jupyter-sphinx
jupyter-sphinx copied to clipboard
Consider relation with IPython sphinxext
Brought up by @Carreau.
IPython has an extension similar in spirit.
As far as I can tell, the key implementation difference is that it is implemented directly via IPython's InteractiveShell instead of nbconvert and nbformat.
Thinking further the practical consequences of this are that IPython's extension:
- is much more lightweight (fewer dependencies) and fast (guessing here)
- by definition only supports IPython code
- only supports text output, as opposed to arbitrary mimetypes/widgets/???
The possible courses of action are:
- Do nothing
- Clarify the relation between the two extensions in the documentation
- Deprecate and then remove the IPython's one
- Take this one over into IPython (would be weird though, because it'd make IPython depend on nbconvert/nbformat and probably a bunch of other stuff)
@Carreau what's your opinion here?
@akhmerov @Carreau Did you have the chance to discuss this internally? :blush:
We were having a small discussion at https://github.com/pvlib/pvlib-python/issues/1379 and we wondered: as of today, would you recommend adopting Jupyter's directive instead of IPython's? Perhaps due to better support or development activity (and even if there is no plan to deprecate the IPython directive any time soon).
To the best of my knowledge your description is correct. The main advantage of jupyter-sphinx over the ipython directive is its ability to treat any jupyter-compatible outputs. You can also consider the executable books stack—that one is much more actively developed.
superceeded by https://github.com/jupyter/jupyter-sphinx/issues/64