Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider relation with IPython sphinxext #36

Closed
akhmerov opened this issue Apr 30, 2019 · 4 comments
Closed

Consider relation with IPython sphinxext #36

akhmerov opened this issue Apr 30, 2019 · 4 comments

Comments

@akhmerov
Copy link
Member

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)
@akhmerov akhmerov added this to the v0.2 milestone Apr 30, 2019
@akhmerov
Copy link
Member Author

@Carreau what's your opinion here?

@akhmerov akhmerov removed this from the v0.2 milestone Jul 8, 2019
@Peque
Copy link

Peque commented Jan 22, 2022

@akhmerov @Carreau Did you have the chance to discuss this internally? 😊

We were having a small discussion at pvlib/pvlib-python#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).

@akhmerov
Copy link
Member Author

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.

@12rambau
Copy link
Contributor

superceeded by #64

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants